Commits

Jean-Tiare Le Bigot  committed 06ff9be

some more enhancement to README and doc intro + typos

  • Participants
  • Parent commits 71c1ad6

Comments (0)

Files changed (3)

 of the limitations with no performance compromise. It is highly inspired by the
 mature `MoongoKit project <http://namlook.github.com/mongokit>`_
 
+- **Full documentation**: http://dynamodb-mapper.readthedocs.org/en/latest/
+- **Report bugs**: https://bitbucket.org/Ludia/dynamodb-mapper/issues
+- **Download**: http://pypi.python.org/pypi/dynamodb-mapper
+
 Requirements
 ============
 
 Also note that Boto 2.3.1 or later is required for autoincrement_int hash keys.
 Earlier versions will fail.
 
+We assume you've correctly set your Boto credentials.
 
 Example usage
 =============
 
-We assume you've correctly set your Boto credentials.
 
-Your Model
-----------
+Quick install
+-------------
+
+>>> pip install dynamodb-mapper
+
+If you have not yet configured Boto, you may simply
+
+>>> export AWS_ACCESS_KEY_ID=<your id key here>
+>>> export AWS_SECRET_ACCESS_KEY=<your secret key here>
+
+
+First Model
+-----------
 
 ::
 
 
 Initial Table creation
 ----------------------
+
 ::
 
     conn = ConnectionBorg()
     e1_maps_after_5 = DoomMap.query(
         hash_key=1,
         range_key_condition=GT(5))
+
+Contribute
+==========
+
+Want to contribute, report a but of request a feature ? The development goes on
+at Ludia's BitBucket account:
+
+- **Report bugs**: https://bitbucket.org/Ludia/dynamodb-mapper/issues
+- **Fork the code**: https://bitbucket.org/Ludia/dynamodb-mapper/overview

File docs/index.rst

 
 .. include:: _include/intro.rst
 
-Want to contribute, report a but of request a feature ? The development goes on
-at Ludia's BitBucket account:
+Documentation
+=============
 
-- `Get/Fork the code <https://bitbucket.org/Ludia/dynamodb-mapper/overview>`_
-- `Bug Report/Feature request <https://bitbucket.org/Ludia/dynamodb-mapper/issues>`_
-
-Content
-=======
+User guide
+----------
 
 .. toctree::
    :maxdepth: 3
    pages/changelog
 
 
-Raw api
-=======
+Api reference
+-------------
 
 .. toctree::
    :maxdepth: 2
    raw_api/*
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
 
+Contribute
+==========
+
+Want to contribute, report a but of request a feature ? The development goes on
+at Ludia's BitBucket account:
+
+- **Report bugs**: https://bitbucket.org/Ludia/dynamodb-mapper/issues
+- **Fork the code**: https://bitbucket.org/Ludia/dynamodb-mapper/overview

File docs/pages/getting_started.rst

 Setup Dynamodb-mapper
 =====================
 
-Instalation
------------
+Installation
+------------
 
 >>> pip install dynamodb-mapper