Skip to content

Move quickstart up further for maximum obviousness #957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 25, 2022
Merged

Move quickstart up further for maximum obviousness #957

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 19 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,6 @@ This is the home of [Delphi](https://delphi.cmu.edu/)'s epidemiological data
API. See our [API documentation](https://cmu-delphi.github.io/delphi-epidata/)
for details on the available data sets, APIs, and clients.

## COVIDcast

At the present, our primary focus is developing and expanding the
[COVIDcast API](https://cmu-delphi.github.io/delphi-epidata/api/covidcast.html),
which offers a number of data streams relating to the ongoing COVID-19
pandemic and powers the [COVIDcast project](https://covidcast.cmu.edu/).

Our other, non-COVID data sources remain generally available on a best-effort
basis. However, non-COVID sources should be held to scrutiny at this time since
they were designed to serve as indicators of typical seasonal ILI
(influenza-like illness), not pandemic ILI or CLI (COVID-like illness).

For a high-level introduction to the COVIDcast API, see our recent
[blog post](https://delphi.cmu.edu/blog/2020/10/07/accessing-open-covid-19-data-via-the-covidcast-epidata-api/).

# Contributing

If you are interested in contributing, we have a quick way for you to make a dev environment.

## Development Quickstart

Requires: Docker, possibly sudo access (depending on your Docker installation and OS).
Expand All @@ -50,9 +31,26 @@ $ [sudo] make test pdb=1
$ [sudo] make test test=repos/delphi/delphi-epidata/integrations/acquisition
```

## Further Documentation
# COVIDcast

At the present, our primary focus is developing and expanding the
[COVIDcast API](https://cmu-delphi.github.io/delphi-epidata/api/covidcast.html),
which offers a number of data streams relating to the ongoing COVID-19
pandemic and powers the [COVIDcast project](https://covidcast.cmu.edu/).

Our other, non-COVID data sources remain generally available on a best-effort
basis. However, non-COVID sources should be held to scrutiny at this time since
they were designed to serve as indicators of typical seasonal ILI
(influenza-like illness), not pandemic ILI or CLI (COVID-like illness).

For a high-level introduction to the COVIDcast API, see our recent
[blog post](https://delphi.cmu.edu/blog/2020/10/07/accessing-open-covid-19-data-via-the-covidcast-epidata-api/).

# Contributing

If you are interested in contributing:

- For more details on the dev environment and the API itself, see the
- For development of the API itself, see the
[development guide](docs/epidata_development.md).
- To suggest changes, additions, or other ways to improve,
[open an issue](https://github.com/cmu-delphi/delphi-epidata/issues/new)
Expand Down