Merge to master (#12)

* Complete writing README.md
* Update gitignore
* Correct URL of project

Author: Mec-iS

.gitignore

@@ -103,3 +103,6 @@ venv.bak/
 # mypy
 .mypy_cache/
 
+#Pipenv generated
+Pipfile
+Pipfile.lock

README.md

@@ -1 +1,21 @@
 # hydra-openapi-parser
+This library contains the OpenAPI parser implemntaion in Python to be used with hydrus and python-hydra-agent.
+
+Currently the library consists of openapi_parser module which helps hydrus parse OpenAPI standard docs.
+
+To install the library:
+
+```
+pip install git+https://github.com/HTTP-APIs/hydra-openapi-parser.git#egg=hydra_openapi_parser
+```
+
+Note :- If using hydrus, the library doesn't need to be installed separately as it is already a part of requirements.txt for hydrus.
+Usage
+
+To import the modules:
+
+```python3
+from hydra_openapi_parser import openapi_parser
+```
+
+Porting out from hydrus the hydraspecs directory

requirements.txt

@@ -1 +1,2 @@
+PyYAML==4.2b1
 -e git+https://github.com/HTTP-APIs/hydra-python-core#egg=hydra_python_core

setup.py

@@ -8,6 +8,6 @@
     description='A Parser from OpenAPI to Hydra specs',
     long_description=open('README.md').read(),
     long_description_content_type="text/markdown",
-    url='https://github.com/HTTP-APIs/hydra_openapi_parser',
+    url='https://github.com/HTTP-APIs/hydra-openapi-parser',
     zip_safe=False
 )