Skip to content

Commit 76ca0a0

Browse files
committed
📒 docs(README.md): Updated README formatting, new projects section
1 parent 825a008 commit 76ca0a0

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The data used by the API comes from two sources:
4747

4848
Before getting started, let's go over some of the common types you will see in the remainder of the documentation:
4949

50-
**Timlines**
50+
**Timelines**
5151

5252
| Key | Description | Type |
5353
|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------|--------|
@@ -102,8 +102,8 @@ GET /api/country/all
102102
GET /api/country/all?timelines=true&properties=true
103103
```
104104

105-
**Sample Response**
106-
105+
<details>
106+
<summary><b>Sample Response</b></summary>
107107
```json
108108
{
109109
"latest": {
@@ -162,6 +162,7 @@ GET /api/country/all?timelines=true&properties=true
162162
]
163163
}
164164
```
165+
</details>
165166

166167
**Response**
167168

@@ -206,7 +207,8 @@ GET /api/state/all
206207
GET /api/state/all?timelines=true&properties=true
207208
```
208209

209-
**Sample Response**
210+
<details>
211+
<summary><b>Sample Response</b></summary>
210212

211213
```json
212214
{
@@ -266,6 +268,7 @@ GET /api/state/all?timelines=true&properties=true
266268
]
267269
}
268270
```
271+
</details>
269272

270273
**Response**
271274

@@ -351,7 +354,8 @@ GET /api/county/all
351354
GET /api/county/all?source=jhu&timelines=true&properties=true
352355
```
353356

354-
**Sample Response**
357+
<details>
358+
<summary><b>Sample Response</b></summary>
355359

356360
```json
357361
{
@@ -468,6 +472,7 @@ GET /api/county/all?source=jhu&timelines=true&properties=true
468472
]
469473
}
470474
```
475+
</details>
471476

472477
**Response**
473478

@@ -686,7 +691,8 @@ GET /api/country/latest
686691
GET /api/county/latest?soruce=jhu
687692
```
688693

689-
**Sample Response**
694+
<details>
695+
<summary><b>Sample Response</b></summary>
690696

691697
```json
692698
{
@@ -697,6 +703,7 @@ GET /api/county/latest?soruce=jhu
697703
"last_updated": "2020-07-12"
698704
}
699705
```
706+
</details>
700707

701708
## Sources
702709

@@ -712,7 +719,8 @@ GET /api/data/sources
712719
GET /api/data/sources
713720
```
714721

715-
**Sample Response**
722+
<details>
723+
<summary><b>Sample Response</b></summary>
716724

717725
```json
718726
{
@@ -722,6 +730,7 @@ GET /api/data/sources
722730
]
723731
}
724732
```
733+
</details>
725734

726735
## Heartbeat
727736

@@ -737,13 +746,15 @@ GET /api/health/heartbeat
737746
GET /api/data/sources
738747
```
739748

740-
**Sample Response**
749+
<details>
750+
<summary><b>Sample Response</b></summary>
741751

742752
```json
743753
{
744754
"is_alive": true
745755
}
746756
```
757+
</details>
747758

748759
## Development
749760

@@ -817,6 +828,12 @@ $ invoke e2e
817828
$ invoke coverage
818829
```
819830

831+
## Projects Using This API
832+
833+
Let me know if you are using the API! It means a great deal.
834+
835+
- [CovidPovertyLink](https://github.com/christorepl/CovidPovertyLink)
836+
820837
## License
821838

822839
See [LICENSE.md](https://github.com/Spiderpig86/coronavirus-us-api/blob/master/LICENSE) for information regarding usage and attribution.

0 commit comments

Comments
 (0)