textwrap LICENSE; tweaks to README

xfxf · Jul 7, 2015 · 9d32660 · 9d32660
1 parent c8df3ad
commit 9d32660
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 6 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,7 +1,19 @@
 Copyright (c) 2015 Rossen Georgiev <[email protected]>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.rst b/README.rst
@@ -21,14 +21,18 @@ What interfaces are availability depends on the ``key``.
     {u'response': {u'steamid': u'103582791429521412', u'success': 1}}
 
 It's not necessary to provide the key when calling any interface method.
-However, you can incase you want to fire one off call with a different ``key``.
+``key``, ``format``, ``raw`` parameters can be specified on ``WebAPI`` to affect
+all method calls, or when calling a specific method.
 Some methods have parameters which need to be a ``list``.
 
-Supported formats by web api are: ``json (default)``, ``vdf``, ``xml``
+Supported formats by web api are: ``json`` (default), ``vdf``, ``xml``
+The response will be deserialized using the appropriet module unless ``raw`` is
+``True``.
 
 .. code:: python
 
     >>> print api.ISteamUser.ResolveVanityURL.doc()  # method doc
+    """
     ResolveVanityURL (version: 1)
 
       Parameters:
@@ -39,10 +43,12 @@ Supported formats by web api are: ``json (default)``, ``vdf``, ``xml``
         vanityurl                 string   required
           - The vanity URL to get a SteamID for
 
+    """
     >>> print api.ISteamUser.doc()  # interface and all methods
     >>> print api.doc()  # all available interfaces
 
-Checkout the wiki has a `list of the currently available API interfaces`_.
+
+Checkout the wiki for a `list of the currently available API interfaces`_.
 
 
 SteamID