Skip to content

Commit

Permalink
docs: Update readme (#101)
Browse files Browse the repository at this point in the history
  • Loading branch information
aadarsh-ram authored May 9, 2022
1 parent 92639cc commit f91ad0e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 17 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Open Food Facts client for your Python applications and scripts
# Open Food Facts Python SDK

<div align="center">
<img width="178" src="https://static.openfoodfacts.org/images/misc/openfoodfacts-logo-en-178x150.png" alt="Open Food Facts"/>
Expand All @@ -13,12 +13,13 @@ Open Food Facts is a database of food products with ingredients, allergens, nutr
### Made by everyone

Open Food Facts is a non-profit association of volunteers.
1800+ contributors like you have added 700 000+ products from 150 countries using our Android, iPhone or Windows Phone app or their camera to scan barcodes and upload pictures of products and their labels.
25000+ contributors like you have added 1.7 million+ products from 150 countries using our Android, iPhone or Windows Phone app or their camera to scan barcodes and upload pictures of products and their labels.

### For everyone

Data about food is of public interest and has to be open. The complete database is published as open data and can be reused by anyone and for any use. Check-out the cool reuses or make your own!
- <https://world.openfoodfacts.org>
Data about food is of public interest and has to be open. The complete database is published as open data and can be reused by anyone and for any use. Check-out the cool reuses or make your own!

The Open Food Facts Website: <https://world.openfoodfacts.org>

## Status

Expand All @@ -33,7 +34,7 @@ Data about food is of public interest and has to be open. The complete database
## Contributing

Any help is welcome, as long as you don't break the continuous integration.
Fork the repository and open a Pull Request directly on the master branch.
Fork the repository and open a Pull Request directly on the "develop" branch.
A maintainer will review and integrate your changes.

Maintainers:
Expand All @@ -44,18 +45,20 @@ Maintainers:

Contributors:

- [Agamit Sudo](https://github.com/agamitsudo)
- Agamit Sudo
- [Daniel Stolpe](https://github.com/numberpi)
- [Enioluwa Segun](https://github.com/enioluwa23)
- [Enioluwa Segun](https://github.com/enioluwas)
- [Nicolas Leger](https://github.com/nicolasleger)
- [Pablo Hinojosa](https://github.com/Pablohn26)
- [Andrea Stagi](https://github.com/astagi)
- [Benoît Prieur](https://github.com/benprieur)
- [Aadarsh A](https://github.com/aadarsh-ram)

## Copyright and License

Copyright 2016-2020 Open Food Facts
Copyright 2016-2022 Open Food Facts

- [License MIT](https://github.com/openfoodfacts/openfoodfacts-python/blob/master/LICENSE)
The Open Food Facts Python SDK is licensed under the [MIT License](https://github.com/openfoodfacts/openfoodfacts-python/blob/develop/LICENSE).

## Installation

Expand All @@ -67,23 +70,21 @@ or:
cd openfoodfacts-python
sudo python setup.py install

## Docs

### Example Usage
## Examples

*Query a Facet*
- *Query a facet*

```python
brands = openfoodfacts.facets.get_brands()
```

*Basic Search*
- *Basic search*

```python
search_result = openfoodfacts.products.search(query)
```

*Add a new product.*
- *Add a new product*

```python
status_code = openfoodfacts.products.add_new_product({
Expand All @@ -97,4 +98,4 @@ status_code = openfoodfacts.products.add_new_product({
})
```

To see all possible capabilities, check out the [usage guide](https://github.com/openfoodfacts/openfoodfacts-python/blob/master/docs/Usage.md).
To see all possible capabilities, check out the [usage guide](https://openfoodfacts.github.io/openfoodfacts-python/Usage/).
2 changes: 1 addition & 1 deletion docs/Usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Usage Guide

This guide provides information on the API. All the I/O is [JSON](www.json.org).
This guide provides information on the methods available within the Open Food Facts Python SDK. All the I/O is [JSON](www.json.org).

- [Open Food Facts](./Usage.md#open-food-facts)
- [Login](./Usage.md#login)
Expand Down

0 comments on commit f91ad0e

Please sign in to comment.