diff --git a/README.md b/README.md index 8d1efd6..e11c807 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ The data used by the API comes from two sources: Before getting started, let's go over some of the common types you will see in the remainder of the documentation: -**Timlines** +**Timelines** | Key | Description | Type | |-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------|--------| @@ -102,8 +102,8 @@ GET /api/country/all GET /api/country/all?timelines=true&properties=true ``` -**Sample Response** - +
+Sample Response ```json { "latest": { @@ -162,6 +162,7 @@ GET /api/country/all?timelines=true&properties=true ] } ``` +
**Response** @@ -206,7 +207,8 @@ GET /api/state/all GET /api/state/all?timelines=true&properties=true ``` -**Sample Response** +
+Sample Response ```json { @@ -266,6 +268,7 @@ GET /api/state/all?timelines=true&properties=true ] } ``` +
**Response** @@ -351,7 +354,8 @@ GET /api/county/all GET /api/county/all?source=jhu&timelines=true&properties=true ``` -**Sample Response** +
+Sample Response ```json { @@ -468,6 +472,7 @@ GET /api/county/all?source=jhu&timelines=true&properties=true ] } ``` +
**Response** @@ -686,7 +691,8 @@ GET /api/country/latest GET /api/county/latest?soruce=jhu ``` -**Sample Response** +
+Sample Response ```json { @@ -697,6 +703,7 @@ GET /api/county/latest?soruce=jhu "last_updated": "2020-07-12" } ``` +
## Sources @@ -712,7 +719,8 @@ GET /api/data/sources GET /api/data/sources ``` -**Sample Response** +
+Sample Response ```json { @@ -722,6 +730,7 @@ GET /api/data/sources ] } ``` +
## Heartbeat @@ -737,13 +746,15 @@ GET /api/health/heartbeat GET /api/data/sources ``` -**Sample Response** +
+Sample Response ```json { "is_alive": true } ``` +
## Development @@ -817,6 +828,12 @@ $ invoke e2e $ invoke coverage ``` +## Projects Using This API + +Let me know if you are using the API! It means a great deal. + +- [CovidPovertyLink](https://github.com/christorepl/CovidPovertyLink) + ## License See [LICENSE.md](https://github.com/Spiderpig86/coronavirus-us-api/blob/master/LICENSE) for information regarding usage and attribution. \ No newline at end of file