From 925ed219cacdcec64f5aa274ac93971cbfab7dda Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Wed, 3 Apr 2019 16:36:58 +0530 Subject: Updated README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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 | -- cgit v1.2.3