Changed typos and added missing words

Author: GrandMoff100

docs/cookbook.rst

@@ -0,0 +1,7 @@
+FAQs
+*****
+
+We want to add some Frequently Asked Questions but frankly questions haven't been asked frequently enough. 
+Until then this page will be left empty. :(
+
+If you have questions open a discussion or issue on the :resource:`repository <issues>`! :)

docs/faq.rst

@@ -10,14 +10,14 @@
 Welcome to Homeassistant API!
 =============================
 
-Homeassistant API is pythonic way to interact with `Homeassistant's REST API integration <https://developers.home-assistant.io/docs/api/rest>`_
+Homeassistant API is a pythonic module that interacts with `Homeassistant's REST API integration <https://developers.home-assistant.io/docs/api/rest>`_
 
 Features
 ----------
 
 - Full consumption of the Homeassistant REST API endpoints
 - Convenient classes that represent data from the API
-- Asyncronous support for integration in async applications or libraries [COMING SOON]
+- Asynchronous support for integration in async applications or libraries [COMING SOON]
 - Modular design for intuitive readability
 
 Getting Started
@@ -31,7 +31,7 @@ Is this your first time using the library? This is the place to get started!
    Home <index>
    quickstart
    usage
-   cookbook
+   faq
    api
 
 
@@ -41,7 +41,7 @@ Example
 .. literalinclude:: ../examples/basic.py
    :language: python
 
-Many more examples are available in the :resource:`repository <examples>`.
+Many more examples are available in the :resource:`repository <examples>`. Feel feel to open a pull request and add your own! See Contributing Guidelines
 
 
 Code Reference
@@ -52,7 +52,7 @@ View the documentation for each class and function :doc:`here <api>`.
 Contributing
 -------------
 
-We warmly welcome contributions.
+We very warmly welcome contributions.
 If you have an idea or some code you want to add to the project please fork :resource:`the repository <repo>`, make your changes, and open a pull request. 
 Most likely your changes will get merged if your code passes flake8 without any errors, and adds some functionality to the project. 
 We'd love to incorporate your unique ideas and perspective!

docs/index.rst

@@ -6,31 +6,32 @@ Prerequisites
 
 Homeassistant
 -----------
-Before using this library, you need to have Homeassistant OS running on a device. Something like a Rasberry Pi or spare laptop.
-If you don't want to do that you can Homeassistant container on your laptop or desktop with docker.
+Before using this library, you need to have Homeassistant OS running on a device.
+Something like a Rasberry Pi or spare laptop.
+If you don't want to do that you can setup a Homeassistant container on your laptop or desktop with docker.
 See `here <https://www.home-assistant.io/installation/>`_ for how to install the installation right for you.
 
 
 
 Configuring the API in Homeassistant
 ======================================
 
-Enable the :code:`api` integration on Homeassistant
+Enable the :code:`api` integration in Homeassistant
 ------------------------------------------------------
 This library requires that you enable the :code:`api` integration on your Homeassistant if you are familiar with setting up integrations.
-The :code:`api` integration is also enabled when you enabled the :code:`default_config` integration.
+The :code:`api` integration is also enabled when you enable the :code:`default_config` integration.
 
 
 Access Token
 --------------
-Then once you have done that you need to head over to your profile and set up a "Long Lived Access Token" for you feed to the script. 
+Then once you have done that you need to head over to your profile and set up a "Long Lived Access Token" to input to your script later.
 A good guide on how to do that is `here <https://www.home-assistant.io/docs/authentication/#your-account-profile>`_
 
 Exposing Homeassistant to the Web
 --------------------------------------
-You may want to setup remote access through a Dynamic DNS server like DuckDNS (a good youtube tutorial on how to do that `here <https://www.youtube.com/watch?v=AK5E2T5tWyM>`_, keep in mind you will need to portforward to set that up.
+You may want to setup remote access through a Dynamic DNS server like DuckDNS (a good youtube tutorial on how to do that `here <https://www.youtube.com/watch?v=AK5E2T5tWyM>`_, keep in mind you will need to port forward to set that up.)
 If you do pursue this your api url will be something like :code:`https://yourhomeassistant.duckdns.org:8123/api`.
-Which is different than what it might have looked like before.
+Which is different than what it could have looked like before.
 Which might have been something like :code:`http://homeassistant.local:8123/api` or :code:`http://localhost:8123/api`
 
 Installation
@@ -77,5 +78,5 @@ Example Usages
 ==============
 Some examples applications of this project include integrating it into a console executable, flask application or just a regular python script.
 You can start a project that allows you to use this from the command line.
-Or add it a discord bot to manage your homeassistant from inside discord (you might want to use AsyncClient if you do)
+Or add it to a discord bot to manage your homeassistant from inside discord (you might want to use AsyncClient if you do)
 In any event, the possibilities are endless, so go make some cool stuff and share it with us!

docs/quickstart.rst

@@ -1,5 +1,70 @@
 Usage
 *********
 
-If you see this we're adding a detailed guide of exactly how to use this library tomorrow.
-So just sit tight and be patient. Thanks!
+This library is centered around the :code:`Client` class.
+Once you have have your api base url and Long Lived Access Token from homeassistant we can start to do stuff.
+The rest of this guide assumes you have the :code:`Client` saved to a :code:`client` variable like this.
+Most of these examples require some integrations to be setup inside homeassistant for them to actually work.
+
+
+.. code-block:: python
+    :linenos:
+
+    import os
+    from homeassistant_api import Client
+
+    URL = '<API BASE URL>'
+    TOKEN = '<LONG LIVED ACCESS TOKEN>'
+
+    client = Client(URL, TOKEN)
+
+
+How To Use...
+==============
+
+Services
+-----------
+
+.. code-block:: python
+    
+    domains = client.get_domains()
+    # {'homeassistant': <Domain homeassistant>, 'notify': <Domain notify>}
+
+    service = domains.cover.services.close_cover # Works the same as domains['cover'].services['open_cover']
+    # <Service open_cover domain="cover">
+
+    changed_states = client.trigger_service('cover', 'close_cover', entity_id='cover.garage_door')
+    # Alternatively (using fetched service from above)
+    changed_states = service.trigger(entity_id='cover.garage_door')
+    # [<EntityState "closing" entity_id="cover.garage_door">]
+
+
+Entities
+---------
+
+.. code-block:: python
+
+    entity_groups = client.get_entities()
+    # {'person': <EntityGroup person>, 'zone': <EntityGroup zone>, ...}
+
+    door = client.get_entity(entity_id='cover.garage_door')
+    # <Entity entity_id="cover.garage_door" state="<EntityState "closed">">
+
+    states = client.get_states()
+    # [<EntityState "above_horizon" entity_id="sun.sun">, <EntityState "zoning" entity_id="zone.home">,...]
+
+    state = client.get_state('sun.sun')
+    # <EntityState "above_horizon" entity_id="sun.sun">
+
+    new_state = client.set_state(state='my ToaTallY Whatever vAlUe 12t87932', group_id='my_favorite_colors', entity_slug='number_one')
+    # <EntityState "my ToaTallY Whatever vAlUe 12t87932" entity_id="my_favorite_colors.number_one">
+    
+    # Alternatively you can set state from the entity class itself
+    from homeassistant_api import State
+    
+    # If you are wondering where door came from its about 15 lines up.
+    door.state.state = 'My new state'
+    door.state.attributes['open_height'] = '23'
+    door.set_state(door.state)
+    # <EntityState "My new state" entity_id="cover.garage_door">
+

docs/usage.rst

@@ -37,5 +37,8 @@
 
 # new_state = client.set_state(state='my ToaTallY Whatever vAlUe 12t87932', group_id='my_favorite_colors', entity_slug='number_one')
 # <EntityState "my ToaTallY Whatever vAlUe 12t87932" entity_id="my_favorite_colors.number_one">
+# Alternatively you can set state from the entity class itself
 
-print(client.get_discovery_info())
+# from homeassistant_api import State
+# door.state.state = 'My new state'
+# door.set_state(door.state)