aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 99c920d..23d6f47 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
# PyAto
A Python Wrapper for the Zomato API
+
+### Initialisation
+```
+import PyAto
+PyAto.setAPIKey("Your Key Here")
+```
+or
+```
+import PyAto as pyato
+pyato.setAPIKey("Your Key Here")
+```
+### Functions
+
+| Function | Required Values | Output |
+|----------|-----------------|--------|
+| getCategories | None | JSON |
+| getCities | Name (String) | JSON |
+| getCityID | Name (String) | Integer |
+| getCollections | CityID (Integer) | JSON |
+| getCuisines | CityID (Integer) | JSON |
+| getGeocode | Latitude & Longitude | JSON |
+| getEstabblishments | CityID | JSON |