Skip to content

Commit 2302343

Browse files
author
Carl Mowday
committed
Added Alternative Radar support in JSON section in the Readme
1 parent dc51f2d commit 2302343

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,52 @@ If you do not want to host the JSON file publicly, you can follow [these steps](
108108

109109
**_Note:_** The JSON file parsing is using D3 library, so consult the [D3 documentation](https://github.com/d3/d3-request/blob/master/README.md#json) for the data format details.
110110

111+
#### Multiple alternative radars in JSON
112+
113+
Just like with Google Spreadsheets, you can provide multiple alternative radars in the same JSON file by returning an object instead of an array.
114+
The keys of the object will be the names of the alternative radars, and show up as buttons at the bottom of the radar, allowing the user to choose which radar to view:
115+
116+
![Alternative Radar buttons shown on the radar](assets/alternative_radars-min.png)
117+
118+
The above example of a JSON structure, split into two different radars would look like this:
119+
120+
```json
121+
{
122+
"First": [
123+
{
124+
"name": "Composer",
125+
"ring": "adopt",
126+
"quadrant": "tools",
127+
"isNew": "TRUE",
128+
"description": "Although the idea of dependency..."
129+
},
130+
{
131+
"name": "Canary builds",
132+
"ring": "trial",
133+
"quadrant": "techniques",
134+
"isNew": "FALSE",
135+
"description": "Many projects have external code..."
136+
}
137+
],
138+
"Second": [
139+
{
140+
"name": "Apache Kylin",
141+
"ring": "assess",
142+
"quadrant": "platforms",
143+
"isNew": "TRUE",
144+
"description": "Apache Kylin is an open source..."
145+
},
146+
{
147+
"name": "JSF",
148+
"ring": "hold",
149+
"quadrant": "languages & frameworks",
150+
"isNew": "FALSE",
151+
"description": "We continue to see teams run..."
152+
}
153+
]
154+
}
155+
```
156+
111157
### Building the radar
112158

113159
Paste the URL in the input field on the home page.

assets/alternative_radars-min.png

99 KB
Loading

0 commit comments

Comments
 (0)