Added a warning to the intro docs for pending API switch-off.

JNRowe · JNRowe · commit 3414c22d25a5 · 2012-04-06T07:51:54.000+01:00
Wondering whether this needs an explicit "don't file bug reports" clause ;)
diff --git a/README.rst b/README.rst
@@ -6,12 +6,24 @@ github2 - Github API v2 library for Python.
     Ask Solem (askh@opera.com)
 :Version: 0.6.1
 
+.. warning::
+
+   GitHub are planning to `switch off API v2`_ on 2012-05-01, you should
+   be looking to replace ``github2`` as soon as possible.
+
+   Both remoteobjects_ and micromodels_ provide easy-to-use functionality for
+   creating bindings to remote APIs, and should significantly reduce the amount
+   of work needed in moving away from GitHub's API v2.
+
 This is a Python library implementing all of the features available in version 2
 of the `Github API`_.
 
 See the ``doc/`` directory for installation instructions and usage information.
 If you prefer you can also read the `documentation online`_.
 
+.. _switch off API v2: https://github.com/blog/1090-github-api-moving-on
+.. _remoteobjects: https://github.com/saymedia/remoteobjects
+.. _micromodels: https://github.com/j4mie/micromodels
 .. _Github API: http://develop.github.com/
 .. _documentation online: http://packages.python.org/github2
 
diff --git a/doc/index.rst b/doc/index.rst
@@ -13,6 +13,19 @@
 ``github2`` - Github API v2 library for Python
 ==============================================
 
+.. warning::
+
+   GitHub are planning to `switch off API v2`_ on 2012-05-01, you should
+   be looking to replace ``github2`` as soon as possible.
+
+   Both remoteobjects_ and micromodels_ provide easy-to-use functionality for
+   creating bindings to remote APIs, and should significantly reduce the amount
+   of work needed in moving away from GitHub's API v2.
+
+.. _switch off API v2: https://github.com/blog/1090-github-api-moving-on
+.. _remoteobjects: https://github.com/saymedia/remoteobjects
+.. _micromodels: https://github.com/j4mie/micromodels
+
 .. pypi-release:: github2
    :prefix: Download
    :class: sidebar
