add docs

Author: lepture

docs/getstarted.rst

@@ -0,0 +1,19 @@
+Get Started
+===========
+
+Flask-OAuthlib contains two parts, the client and the provider.
+At this moment, only the client part is finished.
+
+
+Client
+------
+
+Client part is the same as Flask-OAuth, examples tells more.
+
+Find the examples at https://github.com/lepture/flask-oauthlib/tree/master/example
+
+
+Provider
+--------
+
+**NOT FINISHED**

docs/index.rst

@@ -13,6 +13,16 @@ The client part of Flask-OAuthlib share the same API as Flask-OAuth,
 which is pretty and simple.
 
 
+Features
+--------
+
+- Support for OAuth 1.0a, OAuth2
+- Friendly API (same with Flask-OAuth)
+- Direct integration with Flask
+- Basic support for remote method invocation of RESTful APIs
+- Client part finished
+
+
 User's Guide
 ------------
 
@@ -24,6 +34,8 @@ instructions for getting the most out of Flask-OAuthlib
    :maxdepth: 2
 
    intro
+   install
+   getstarted
 
 
 API Documentation

docs/install.rst

@@ -0,0 +1,56 @@
+.. _install:
+
+Installation
+============
+
+This part of the documentation covers the installation of Flask-OAuthlib.
+The first step to using any software package is getting it properly installed.
+
+
+Distribute & Pip
+----------------
+
+Installing Flask-OAuthlib is simple with `pip <http://www.pip-installer.org/>`_::
+
+    $ pip install Flask-OAuthlib
+
+or, with `easy_install <http://pypi.python.org/pypi/setuptools>`_::
+
+    $ easy_install Flask-OAuthlib
+
+But, you really `shouldn't do that <http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install>`_.
+
+
+
+Cheeseshop Mirror
+-----------------
+
+If the Cheeseshop is down, you can also install Flask-OAuthlib from one of the
+mirrors. `Crate.io <http://crate.io>`_ is one of them::
+
+    $ pip install -i http://simple.crate.io/ Flask-OAuthlib
+
+
+Get the Code
+------------
+
+Flask-OAuthlib is actively developed on GitHub, where the code is
+`always available <https://github.com/lepture/flask-oauthlib>`_.
+
+You can either clone the public repository::
+
+    git clone git://github.com/lepture/flask-oauthlib.git
+
+Download the `tarball <https://github.com/lepture/flask-oauthlib/tarball/master>`_::
+
+    $ curl -OL https://github.com/lepture/flask-oauthlib/tarball/master
+
+Or, download the `zipball <https://github.com/lepture/flask-oauthlib/zipball/master>`_::
+
+    $ curl -OL https://github.com/lepture/flask-oauthlib/zipball/master
+
+
+Once you have a copy of the source, you can embed it in your Python package,
+or install it into your site-packages easily::
+
+    $ python setup.py install

docs/intro.rst

@@ -7,6 +7,21 @@ Flask-OAuthlib is designed as a replacement for Flask-OAuth. It depends on
 the oauthlib module.
 
 
+Why
+---
+
+The original `Flask-OAuth`_ is lack of maintenance, and oauthlib_ is a
+promising replacement for oauth2.
+
+.. _`Flask-OAuth`: http://pythonhosted.org/Flask-OAuth/
+.. _oauthlib: https://github.com/idan/oauthlib
+
+There are lots of non-standard services that claim themself as oauth providers,
+but the API are always broken. When rewrite a oauth extension for flask,
+I do take them into consideration, Flask-OAuthlib does support those
+non-standard services.
+
+
 import this
 -----------