Merge pull request #261 from lzpap/api_docs_rethink

Improve API documentation
iotaledger · Nov 14, 2019 · e033dc8 · e033dc8
2 parents a68254d + dba8acf
commit e033dc8
Show file tree

Hide file tree

Showing 10 changed files with 699 additions and 613 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -29,7 +29,7 @@ We're pretty open about how people contribute to PyOTA, but there are a few thin
 - Please do not post support requests here.  Use the ``#python`` channel on `Discord`_ 
 - Please do not propose new API methods here.  There are multiple IOTA API libraries out there, and they must all have the same functionality.
 
-  - That said, if you have an idea for a new API method, please share it on the ``#developers`` channel in `Discord`_ so that IOTA Foundation members can evaluate it!
+  - That said, if you have an idea for a new API method, please share it on the ``#clients-discussion`` channel in `Discord`_ so that IOTA Foundation members can evaluate it!
 
 
 Need Some Inspiration?

diff --git a/README.rst b/README.rst
@@ -26,9 +26,9 @@ Dependencies
 ============
 PyOTA is compatible with Python 3.7, 3.6, 3.5 and 2.7
 
-============
-Installation
-============
+=============
+Install PyOTA
+=============
 To install the latest version::
 
   pip install pyota