Update index.rst

lcosmin · Aug 22, 2014 · bb86278 · bb86278
1 parent 799a8a2
commit bb86278
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,6 +2,10 @@
 boardgamegeek - A Python API for boardgamegeek.com
 ==================================================
 
+.. warning::
+
+   The documentation is a work in progress. You can check out the unit tests for how to use the library.
+
 
 Introduction
 ============
@@ -91,4 +95,4 @@ Indices and tables
 
 .. _BoardGameGeek: http://www.boardgamegeek.com
 .. _libBGG: https://github.com/philsstein/libBGG
-.. _requests-cache: https://pypi.python.org/pypi/requests-cache
+.. _requests-cache: https://pypi.python.org/pypi/requests-cache