add README

PeiShang · Apr 8, 2018 · 33f8cad · 33f8cad
1 parent da1c590
commit 33f8cad
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# opendota2 v0.1.0
+Author [PeiShang](https://github.com/PeiShang)
+The [OpenDota web api](https://docs.opendota.com/) in python
+[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid)
+## 1.Requirement
+- Python version 3.0+
+## 2.Download and install
+- You can Clone the repository to your local machine via:
+```shell
+git clone git://github.com/PeiShang/opendota2
+```
+- Then cd to the folder and run:
+```shell
+pip install .
+```
+## 3.Usage
+- You can import and use the pakages like:
+```python
+import opendota2 as od
+match_data = od.get_match(match_id=3812844133) # Get the match data 
+```
+See the [OpenDota web api](https://docs.opendota.com/) for more information about parameters
+
diff --git a/opendota2/.__init__.py.swp b/opendota2/.__init__.py.swp
diff --git a/opendota2/src/.urls.py.swp b/opendota2/src/.urls.py.swp
diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 
 setup(
     name="opendota2",
-    version=0.1.0,
+    version="0.1.0",
     author="PeiShang",
     author_email="[email protected]",
     url="https://github.com/PeiShang/opendota2",