Documentation improvements

Author: Galarzaa90

CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## Version 1.0.0 (2018-12-23)
+- Added support for TibiaData JSON parsing. To have interoperability between Tibia.com and TibiaData.
+- Added support for parsing Houses, House lists, World and World list
+- Added support for many missing attributes in Character and Guilds.
+- All objects are now serializable to JSON strings.
+
 ## Version 0.1.0 (2018-08-17)
 Initial release:
 - Parses content from tibia.com

README.md

@@ -9,6 +9,14 @@ No fetching is done by this module, you must provide the html content.
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tibia.py.svg)
 ![PyPI - License](https://img.shields.io/pypi/l/tibia.py.svg)
 
+**Features:**
+
+- Converts data into well-structured Python objects.
+- Type consistent attributes.
+- All objects can be converted to JSON strings.
+- Can be used with any networking library.
+- Support for characters, guilds, houses and worlds.
+
 ## Installing
 Install and update using pip
 
@@ -36,7 +44,7 @@ async def get_character(name):
 
   async with aiohttp.ClientSession() as session:
     async with session.get(url) as resp:
-    content = await resp.text()
+        content = await resp.text()
   character = tibiapy.Character.from_content(content)
   return character
 

docs/index.rst

@@ -2,60 +2,37 @@
    sphinx-quickstart on Mon Aug  6 17:46:14 2018.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
-.. currentmodule:: tibiapy
-
-.. toctree::
-   :hidden:
-   :maxdepth: 3
-
-   api
 
 ========
 Tibia.py
 ========
 
 
-Tibia.py is a library for parsing HTML content from Tibia.com_. into python objects.
-
-This library only performs parsing, to fetch content you need to use external libraries.
-
-.. code-block:: python
-
-   import aiohttp
-   import requests
-   import tibiapy
-
-   # Asynchronously
-   async def get_character(name):
-      url = tibiapy.Character.get_url(name)
-
-      try:
-         async with aiohttp.ClientSession() as session:
-            async with session.get(url) as resp:
-               content = await resp.text()
-      character = tibiapy.Character.from_content(content)
-      return character
+Tibia.py is a library for parsing HTML content from Tibia.com_. into Python objects.
+It can also parse json content from TibiaData_.
 
-   # Synchronously
-   def get_character_sync(name):
-      url = tibiapy.Character.get_url(name)
-
-      r = requests.get(url)
-      content = r.text()
-      character = tibiapy.Character.from_content(content)
-      return character
+**Features:**
 
+- Converts data into well-structured Python objects.
+- Type consistent attributes.
+- All objects can be converted to JSON strings.
+- Can be used with any networking library.
+- Support for characters, guilds, houses and worlds.
 
 
 .. _Tibia.com: https://www.tibia.com/news/?subtopic=latestnews
-
-
-
+.. _TibiaData: https://www.tibiadata.com/
 
 
 Indices and tables
 ==================
 
+.. toctree::
+   :maxdepth: 3
+
+   intro
+   api
+
 * :ref:`genindex`
 * :ref:`search`
 

docs/intro.rst

@@ -0,0 +1,64 @@
+============
+Introduction
+============
+
+Prerequisites
+=============
+Tibia.py requires Python 3.5 or higher.
+Dependencies are installed automatically when installing the package.
+
+However, since it uses ``lxml`` for parsing, on Linux you may require to install libxml on your system.
+
+
+.. code-block:: shell
+
+    sudo apt-get install libxml2-dev libxslt-dev python-dev
+
+Windows users are usually safe from this. For more information check out `lxml installation page`_
+.
+
+
+
+Installation
+============
+Tibia.py can be installed from `PyPi`_ using:
+
+.. code-block:: shell
+
+    python -m pip install tibia.py
+
+.. _lxml installation page: https://lxml.de/installation.html
+.. _PyPi: https://pypi.org/
+
+Usage
+=====
+This library only performs parsing, to fetch content you need to use external libraries.
+
+The main models have a ``get_url``/``get_url_tibiadata`` method that can be used to get their Tibia.com/TibiaData.com page.
+With the url, the html/json content can be fetched and then passed to their ``from_content``/``from_tibiadata`` methods.
+
+.. code-block:: python
+
+   import aiohttp
+   import requests
+   import tibiapy
+
+   # Asynchronously
+   async def get_character(name):
+      url = tibiapy.Character.get_url(name)
+
+      try:
+         async with aiohttp.ClientSession() as session:
+            async with session.get(url) as resp:
+               content = await resp.text()
+      character = tibiapy.Character.from_content(content)
+      return character
+
+   # Synchronously
+   def get_character_sync(name):
+      url = tibiapy.Character.get_url(name)
+
+      r = requests.get(url)
+      content = r.text
+      character = tibiapy.Character.from_content(content)
+      return character