Merge branch 'master' of github.com:SebRut/pygrocy

SebRut · Apr 23, 2019 · 220a32f · 220a32f
2 parents cc3345f + 37ab46d
commit 220a32f
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,16 @@
 # pygrocy
+[![Build Status](https://travis-ci.com/SebRut/pygrocy.svg?branch=master)](https://travis-ci.com/SebRut/pygrocy)
+[![Coverage Status](https://coveralls.io/repos/github/SebRut/pygrocy/badge.svg?branch=master)](https://coveralls.io/github/SebRut/pygrocy?branch=master)
+![PyPI](https://img.shields.io/pypi/v/pygrocy.svg)
+
+## Example
+```
+from pygrocy import Grocy
+
+# get a grocy instance
+grocy = Grocy("https://example.com/api/", "GROCY_API_KEY")
+
+# get current stock
+for entry in grocy.stock():
+    print("{} in stock for product id {}".format(entry.product_id, entry.amount))
+```