test docs update

README.md

@@ -44,7 +44,7 @@ returns a 304 Not-Modified response, the cache is used, saving having to re-down
 
 
 ## Install
-Stable
+Urlquick2 officially supports Python 2.7 & 3.6+.
 ```console
 $ pip install urlquick
 ```

docs/README.md

@@ -0,0 +1,3 @@
+[![Documentation Status](https://readthedocs.org/projects/urlquick/badge/?version=stable)](https://urlquick.readthedocs.io/en/stable/?badge=stable)
+
+# Please GOTO: [Read the Docs](https://urlquick.readthedocs.io)

docs/index.rst

@@ -1,64 +1,28 @@
-.. urlquick documentation master file, created by
+.. urlquick2 documentation master file, created by
    sphinx-quickstart on Fri Apr  7 17:02:08 2017.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to urlquick's documentation!
+Welcome to urlquick's 2 documentation!
 ====================================
 
 .. include::
-    ../README.rst
+    ../README.md
 
 API
 ===
 
 .. autodata:: urlquick.MAX_AGE
-.. data:: urlquick.CACHE_LOCATION
-
-    Location of the cache files. Defaults to the current working directory. It Will create a ".cache" subdirectory.
-
-.. autofunction:: urlquick.request
-.. autofunction:: urlquick.get
-.. autofunction:: urlquick.head
-.. autofunction:: urlquick.post
-.. autofunction:: urlquick.put
-.. autofunction:: urlquick.patch
-.. autofunction:: urlquick.delete
-.. autofunction:: urlquick.cache_cleanup
-
-.. autoexception:: urlquick.UrlError
-.. autoexception:: urlquick.Timeout
-.. autoexception:: urlquick.MaxRedirects
-.. autoexception:: urlquick.ContentError
-.. autoexception:: urlquick.ConnError
-.. autoexception:: urlquick.SSLError
-.. autoexception:: urlquick.HTTPError
-
-Session Class
--------------
-
-.. autoclass:: urlquick.Session
-    :members:
+.. autodata:: urlquick.CACHE_LOCATION
+.. autoexception:: urlquick.CacheError
 
 Response Object
 ---------------
 
 .. autoclass:: urlquick.Response
     :members:
 
-    .. autoattribute:: urlquick.Response.content
-    .. autoattribute:: urlquick.Response.cookies
-    .. autoattribute:: urlquick.Response.encoding
-    .. autoattribute:: urlquick.Response.links
-    .. autoattribute:: urlquick.Response.text
-
-Request Object
---------------
-.. autoclass:: urlquick.Request
-    :members:
-
 External Links
 ==============
-Requests Quickstart: http://docs.python-requests.org/en/master/user/quickstart/
-
-Bug Tracker: https://github.com/willforde/urlquick/issues
+Requests Documentation: https://requests.readthedocs.io/en/master/
+Bug Tracker: https://github.com/willforde/urlquick/issues

urlquick.py

@@ -107,7 +107,7 @@
     codes.permanent_redirect,
 }
 
-#: The default location for the cached files
+#: Location for the cache directory. Defaults to the current working directory.
 CACHE_LOCATION = _CACHE_LOCATION
 
 #: The time in seconds where a cache item is considered stale.