feat(*): Minor fixes & initial docs

Author: CuriousLearner

README.md

@@ -1,6 +1,6 @@
 # API Stub Generator
 
-[![Build Status](https://travis-ci.org/CuriousLearner/api-stub.svg?branch=master)](https://travis-ci.org/CuriousLearner/api-stub)
+[![Build Status](https://travis-ci.org/CuriousLearner/API-stub-generator.svg?branch=master)](https://travis-ci.org/CuriousLearner/API-stub-generator)
 
 Mock proposed API endpoints with stub.
 
@@ -10,6 +10,35 @@ I'm a lazy programmer. Basically, if you would tell me that I've to do the same
 
 The proposed API docs I write, have to be then mocked for APP / Front-End Developers so that they're not blocked by actual API calls. Later they can replace these stubs with actual API calls. With more requirements coming in, the proposed endpoint changes over time and the stubs have to be updated. I found myself in a viscous circle of keeping the both up to date which wastes my dev cycles (where I can work on generating actual endpoints) & thus created this small utility to help me.
 
+## Setup
+
+Clone the repo & `cd` to it:
+
+```
+git clone https://github.com/CuriousLearner/API-stub-generator.git && cd API-stub-generator
+```
+
+Install pipenv
+
+```
+[sudo] pip install pipenv
+```
+
+Install all dependencies using pipenv
+
+```
+pipenv install
+```
+
+## Usage
+
+Run `pipenv run python serialize_data.py` to generate JSON file named `endpoints_data.json`
+
+Run `pipenv run python create_mock_endpoints.py` to generate `app.py` with all the code for the Mocked end points.
+
+Run `pipenv run python app.py` & hit any endpoint that you defined in the `proposed_endpoints.md` doc.
+
+
 ## GET - SET - GO
 
 - Avoiding the viscous circle of updating docs and stubs in three easy steps.

tests/test_mock_endpoint_creation.py

@@ -9,7 +9,7 @@
 @pytest.mark.datafiles(
     os.path.join(FIXTURE_DIR, 'endpoints_data.json'),
 )
-def test_data_serialization(datafiles):
+def test_generated_code_from_serialization(datafiles):
     data = datafiles.listdir()[0].read()
 
     json_data = json.loads(data)