fix(README): add documentation link and pip install.

JT-Ushio · Dec 28, 2018 · d28be06 · d28be06
1 parent 61bcfd9
commit d28be06
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -9,17 +9,28 @@ Universal data IO and neural network modules in NLP tasks.
 # Requirements
 
 + Python>=3.6
-+ bidict
-+ overrides
++ bidict==0.17.5
++ numpy==1.15.4
++ numpydoc==0.8.0
++ overrides==1.9
++ pytest==4.0.2
 
 ##### If you need dynet neural network:
 
 + dynet>=2.0
 
 
 
+# Installing via pip
+
+```bash
+pip install antu
+```
+
+
+
 # Resources
 
-+ [Documentation](https://wait)
++ [Documentation](https://antu.readthedocs.io/en/latest/index.html)
 + [Source Code](https://github.com/AntNLP/antu)
 
diff --git a/setup.py b/setup.py
@@ -15,7 +15,7 @@ def read_file(fname):
     author='AntNLP',
     author_email='taoji.cs@gmail.com',
     description='Universal data IO and neural network modules in NLP tasks',
-    long_description = read_file("README.txt"),
+    long_description = read_file("README.md"),
     license='Apache',
     packages=find_packages(),
     install_requires=[],
@@ -29,4 +29,4 @@ def read_file(fname):
     zip_safe=True,
     include_package_data=True,
     platforms='any',
-)
+)