Updating README.md

Added info.md and CONTRIBUTING.md

Author: jiminald

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contribution guidelines
+
+Contributing to this project should be as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+
+## Github is used for everything
+
+Github is used to host code, to track issues and feature requests, as well as accept pull requests.
+
+Pull requests are the best way to propose changes to the codebase.
+
+1. Fork the repo and create your branch from `master`.
+2. If you've changed something, update the documentation.
+3. Make sure your code lints (using black).
+4. Issue that pull request!
+
+## Any contributions you make will be under the Apache 2.0 Software License
+
+In short, when you submit code changes, your submissions are understood to be under the same [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/jiminald/unraid/issues)
+
+GitHub issues are used to track public bugs.  
+Report a bug by [opening a new issue](https://github.com/jiminald/unraid/issues/new/choose); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its Apache 2.0 License.

README.md

@@ -1,24 +1,34 @@
 # homeassistant-unraid
 
-![GitHub](https://img.shields.io/github/license/jiminald/homeassistant-unraid)
+![GitHub](https://img.shields.io/github/license/jiminald/unraid)
 [![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/custom-components/hacs)
 
 This is a custom component for [Home Assistant](http://home-assistant.io) that adds [UnRAID](http://unraid.net) data as a sensor to HA.
 
-Tested on Unraid 6.8-RC9
+This component uses a GraphQL API component for a under development module [unraid.net](https://github.com/limetech/Unraid.net)
+
+Tested on Unraid 6.8
+
+## Setup
+
+First, you will need to install the unraid.net plugin onto your unraid instance [https://github.com/limetech/Unraid.net/blob/next/Unraid.net.plg](https://github.com/limetech/Unraid.net/blob/next/Unraid.net.plg)
+
+This will add a new section to your Settings > Management Access titled unraid.net. Register your instance using your unraid.net forum account.
+
+Now SSH into your unraid installation and run the following command
+`/etc/rc.d/rc.unraid-api start`
 
 ## Config
 
-In `/boot/config/plugins/dynamix/dynamix.cfg` contains a section labelled `[remote]`, here you should be able to find your `api_key`.
+Once you've completed the setup, go to `/boot/config/plugins/dynamix/dynamix.cfg` contains a section labelled `[remote]`, here you should be able to find your `api_key`.
 
 ```ini
 [remote]
 apikey="c53a2R6c4A54043N4f4a65D4ba9fO103fbM491112Aa1519Padc7I2b735Ka768eE614d2Ydfbf7"
 ```
 
-Copy this into your Home Assistant config along with the URL to your UnRAID installation
-```yaml
-unraid:
-    - host: http://192.168.0.10/
-      api_key: c53a2R6c4A54043N4f4a65D4ba9fO103fbM491112Aa1519Padc7I2b735Ka768eE614d2Ydfbf7
-```
+Go to your Home Assistance installation and setup a new integration. Find unraid in the list and enter the URL to your installation and the API Key found in the file above.
+
+## Contributions are welcome!
+
+If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)

info.md

@@ -0,0 +1,34 @@
+# homeassistant-unraid
+
+![GitHub](https://img.shields.io/github/license/jiminald/unraid)
+[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/custom-components/hacs)
+
+This is a custom component for [Home Assistant](http://home-assistant.io) that adds [UnRAID](http://unraid.net) data as a sensor to HA.
+
+This component uses a GraphQL API component for a under development module [unraid.net](https://github.com/limetech/Unraid.net)
+
+Tested on Unraid 6.8
+
+## Setup
+
+First, you will need to install the unraid.net plugin onto your unraid instance [https://github.com/limetech/Unraid.net/blob/next/Unraid.net.plg](https://github.com/limetech/Unraid.net/blob/next/Unraid.net.plg)
+
+This will add a new section to your Settings > Management Access titled unraid.net. Register your instance using your unraid.net forum account.
+
+Now SSH into your unraid installation and run the following command
+`/etc/rc.d/rc.unraid-api start`
+
+## Config
+
+Once you've completed the setup, go to `/boot/config/plugins/dynamix/dynamix.cfg` contains a section labelled `[remote]`, here you should be able to find your `api_key`.
+
+```ini
+[remote]
+apikey="c53a2R6c4A54043N4f4a65D4ba9fO103fbM491112Aa1519Padc7I2b735Ka768eE614d2Ydfbf7"
+```
+
+Go to your Home Assistance installation and setup a new integration. Find unraid in the list and enter the URL to your installation and the API Key found in the file above.
+
+## Contributions are welcome!
+
+If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)