Updated Documentation (#16)

HISTORY.rst

@@ -8,7 +8,7 @@ History
 * First release on PyPI.
 
 0.1.1 (2017-7-25)
-------------------
+~~~~~~~~~~~~~~~~~
 
 * Bug fixes
 * Implemented Local Best PSO

docs/features.rst

@@ -0,0 +1,31 @@
+========
+Features
+========
+
+Currently, PySwarms has implemented the following optimizers:
+
+Single-Objective Optimizers
+---------------------------
+
+Continuous 
+~~~~~~~~~~
+
+These optimizers are used on problems involving a continuous space (bounded or unbounded),
+and is optimized given a single objective function.
+
+* :mod:`pyswarms.single.gb` - global-best Particle Swarm Optimization algorithm with a star-topology. Every
+particle compares itself with the best-performing particle in the swarm.
+* :mod:`pyswarms.single.lb` - local-best Particle Swarm Optimization algorithm with a ring-topology. Every
+particle compares itself only with its nearest-neighbours as computed by a distance metric.
+
+
+Utilities
+---------
+
+Test Functions
+~~~~~~~~~~~~~~
+
+These functions can be used as benchmark tests for assessing the performance of the optimization
+algorithm.
+
+* :mod:`pyswarms.utils.functions.single_obj` - single-objective test functions

docs/index.rst

@@ -1,28 +1,55 @@
 Welcome to PySwarms's documentation!
 ======================================
 
-PySwarms is a particle swarm optimization (PSO) toolkit that enables researchers to test variants
-of the PSO technique in different contexts. Users can define their own function, or use one of the
-benchmark functions in the library. It is built on top of numpy and scipy, and is very extensible to
-accommodate other PSO variations.
+.. image:: https://img.shields.io/pypi/v/pyswarms.svg
+        :target: https://pypi.python.org/pypi/pyswarms
+
+.. image:: https://img.shields.io/travis/ljvmiranda921/pyswarms.svg
+        :target: https://travis-ci.org/ljvmiranda921/pyswarms
+
+.. image:: https://readthedocs.org/projects/pyswarms/badge/?version=latest
+        :target: https://pyswarms.readthedocs.io/en/latest/?badge=latest
+        :alt: Documentation Status
+
+.. image:: https://pyup.io/repos/github/ljvmiranda921/pyswarms/shield.svg
+     :target: https://pyup.io/repos/github/ljvmiranda921/pyswarms/
+     :alt: Updates
+
+PySwarms is a simple, Python-based, Particle Swarm Optimization (PSO) library.
+
+* Free software: MIT license
+* Github repository: https://github.com/ljvmiranda921/pyswarms
+
+Launching pad
+-------------
+
+* If you want to use PySwarms in your project, check the `Installation guide <https://pyswarms.readthedocs.io/en/latest/installation.html>`_
+and the `use-case examples <https://pyswarms.readthedocs.io/en/latest/examples/usecases.html>`_ in this documentation.
+* If you are a researcher in the field of swarm intelligence, and would like to include your technique in our list of optimizers, check our
+`contributing <https://pyswarms.readthedocs.io/en/latest/contributing.html>`_ page to see how to implement your optimizer using the current base
+classes in the library.
+* If you are an open-source contributor, and would like to help PySwarms grow, be sure to check our `Issues <https://github.com/ljvmiranda921/pyswarms/issues>`_ page in Github, and see the open
+issues with the tag `help-wanted <https://github.com/ljvmiranda921/pyswarms/labels/help%20wanted>`_. Moreover, we accommodate contributions from first-time contributors! Just check our
+`first-timers-only <https://github.com/ljvmiranda921/pyswarms/labels/first-timers-only>`_ tag for open issues (Don't worry! We're happy to help you make your first PR!).
+
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: General
 
-   readme
+   features
    installation
    authors
    history
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Examples
 
    Use-cases <examples/usecases>
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Developer's Guide
 
    contributing