how do i intall it

README.md

@@ -10,6 +10,10 @@ Still work in progress, but the vacuum entity has been fully ported over.
 - [ ] Actions
 - [ ] Dynamically grab rooms and add them to the UI
 
+## Why?
+
+I found that working with jeremywillans' implementation was nice and almost effortless, but I'd prefer to not have a YAML configuration and work with it by a more native integration that adds entities and isn't bound to making a lot of helpers per room.
+
 ## Setup
 
 ### Prerequisites / Recommendations
@@ -105,11 +109,13 @@ Locate and install the `rest980` addon, then update and save the configuration o
 
 ## Step 2: Setting up the Integration
 
+rest980 will gather all the data about our robot, but the integration will format it perfectly, creating entities and a vacuum device.
+
 <details open>
   <summary>
   For HACS users
   </summary>
-  Add this custom repository, `https://github.com/ia74/roomba_rest980` to HACS as an Integration. Search for the addon ("iRobot Roomba (rest980)")
+  Add this custom repository, `https://github.com/ia74/roomba_rest980` to HACS as an Integration. Search for the addon ("iRobot Roomba (rest980)") and install it!
 </details>
 
 <details>
@@ -118,3 +124,63 @@ Locate and install the `rest980` addon, then update and save the configuration o
   </summary>
   Clone this repository, `https://github.com/ia74/roomba_rest980`, and add the custom component folder (`roomba_rest980`) to your Home Assistant's `config/custom_components` folder.
 </details>
+
+When you install the integration and restart Home Assistant, you will notice it picking up your Roomba.
+
+![Discovery](img/discovery.png)
+
+This is not due to your rest980 API server being discovered, rather the integration finding your Roomba on the local network.
+
+> If you do not see this, that is okay; it only means HA was able to fully detect a roomba through it's network identifiers.
+
+## Step 3: Adding your Roomba!
+
+If you see the autodiscovered integration, press "Add"!  
+You'll be presented with this popup. It will be styled much better later, but this works well enough for now.
+
+![Adding the robot](img/ADD.png)
+
+Input your rest980 server's url like so:
+
+```
+http://localhost:3000
+```
+
+and don't leave any trailing /s.
+
+If you did it right, you'll see a success screen!  
+
+![Added the config!](img/ADDeD.png)
+
+If all has gone right, checking the device will show something like this:
+
+![Added the config!](img/fin.png)
+
+But those aren't your rooms....
+
+## Step 4: Rooms!
+
+TO BE CONTINUED...
+Rooms are not given to us easily, but a fix is in progress for that.
+
+## Step 5: Robot Maintenance / Done!
+
+> Unfortunately, this is not implemented yet, alongside any other action.
+
+This integration will eventually support the maintenance function of the Roomba, but still is not implemented
+
+## Cleaning a room using the Roomba from HA
+
+> Unfortunately, this is not implemented yet, alongside any other action.
+
+In any configuration you'd like, you may lay the switches on the dashboard and switch them in the order you want them cleaned. After that, press Start on the native Vacuum!
+
+## Note:
+
+Unfortunately, this is about where my current progress ends. We gather all the possible data and display it. I will be working on this integration however and eventually these features will be fully supported.
+
+## Backwards Compatibility
+
+Minus the actions (currently!), the integration adds all the attributes that you would expect from `jeremywillans` implementation, even adding an `extendedState` attribute that gives you "Ready", "Training", "Spot", etc. since HA doesnt do that natively for some odd reason.
+
+![Compatibility](img/compat.png)