Skip to content
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.

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

docs: updated sample output image within README.md and located image … #149

Merged
merged 1 commit into from
May 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

</br>

# Ozone
# Ozone

![SVG of ozone logo](/src/media/ozone_logo.svg)

Expand All @@ -19,7 +19,7 @@

</div>

Getting air quality data with Python should be easy and straightforward - and that's exactly what Ozone can help you with.
Getting air quality data with Python should be easy and straightforward - and that's exactly what Ozone can help you with.
With Ozone, just 4 lines of code are enough to get you the data you need. And the best part is that you can trust this data to be accurate and reliable, since the package uses the World Air Quality Index's API under the hood! ✅ 📈

Use Ozone to **get real-time air quality data, or historical data from 2014 onwards**, and fetch air quality data **for anywhere in the world** in seconds.
Expand Down Expand Up @@ -67,7 +67,7 @@ Get your token [here](https://aqicn.org/data-platform/token/#/)!
import ozone as ooo

o3 = ooo.Ozone('YOUR_PRIVATE_TOKEN')
data = o3.get_city_air('New Delhi')
data = o3.get_city_air('New Delhi')
```

for many cities:
Expand Down Expand Up @@ -108,8 +108,7 @@ Ozone can fetch the following parameters:
* `w`: wind speed, a measure of air in motion. It is measured in kilometers per hour (km/h)

Sample output:
<img width="1065" alt="blehblhe" src="https://user-images.githubusercontent.com/68847270/159113134-e7e2d76d-c64d-4f96-83c4-e85d8c76b503.png">

<img width="1065" alt="blehblhe" src="./src/media/sample-output.png">

## Contributing and submitting Pull requests

Expand Down
Binary file added src/media/sample-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.