Skip to content

Commit

Permalink
📒 docs(README.md): Updated README formatting, new projects section
Browse files Browse the repository at this point in the history
  • Loading branch information
Spiderpig86 committed Aug 10, 2020
1 parent 825a008 commit 76ca0a0
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------|--------|
Expand Down Expand Up @@ -102,8 +102,8 @@ GET /api/country/all
GET /api/country/all?timelines=true&properties=true
```

**Sample Response**

<details>
<summary><b>Sample Response</b></summary>
```json
{
"latest": {
Expand Down Expand Up @@ -162,6 +162,7 @@ GET /api/country/all?timelines=true&properties=true
]
}
```
</details>

**Response**

Expand Down Expand Up @@ -206,7 +207,8 @@ GET /api/state/all
GET /api/state/all?timelines=true&properties=true
```

**Sample Response**
<details>
<summary><b>Sample Response</b></summary>

```json
{
Expand Down Expand Up @@ -266,6 +268,7 @@ GET /api/state/all?timelines=true&properties=true
]
}
```
</details>

**Response**

Expand Down Expand Up @@ -351,7 +354,8 @@ GET /api/county/all
GET /api/county/all?source=jhu&timelines=true&properties=true
```

**Sample Response**
<details>
<summary><b>Sample Response</b></summary>

```json
{
Expand Down Expand Up @@ -468,6 +472,7 @@ GET /api/county/all?source=jhu&timelines=true&properties=true
]
}
```
</details>

**Response**

Expand Down Expand Up @@ -686,7 +691,8 @@ GET /api/country/latest
GET /api/county/latest?soruce=jhu
```

**Sample Response**
<details>
<summary><b>Sample Response</b></summary>

```json
{
Expand All @@ -697,6 +703,7 @@ GET /api/county/latest?soruce=jhu
"last_updated": "2020-07-12"
}
```
</details>

## Sources

Expand All @@ -712,7 +719,8 @@ GET /api/data/sources
GET /api/data/sources
```

**Sample Response**
<details>
<summary><b>Sample Response</b></summary>

```json
{
Expand All @@ -722,6 +730,7 @@ GET /api/data/sources
]
}
```
</details>

## Heartbeat

Expand All @@ -737,13 +746,15 @@ GET /api/health/heartbeat
GET /api/data/sources
```

**Sample Response**
<details>
<summary><b>Sample Response</b></summary>

```json
{
"is_alive": true
}
```
</details>

## Development

Expand Down Expand Up @@ -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.

0 comments on commit 76ca0a0

Please sign in to comment.