Add README.md

README.md

@@ -0,0 +1,88 @@
+# Raspberry | Pi
+
+Middleware in python2.7 to show some information about your Raspberry Pi:
+
+![alt text](https://i.postimg.cc/j2WPkKnv/imageedit-3-9864224351.png)
+
+![alt text](https://i.postimg.cc/76tSVbhf/json.png)
+
+
+Interfaces:
+- IP Address;
+- Mac Address;
+  
+Disk and CPU:
+- Disk used;
+- Disk free;
+- Disk total;
+- CPU temperature;
+
+Memory:
+- Used;
+- Free;
+- Total;
+
+## Getting Started
+
+The modules strive to be simple, well documented and modification friendly.
+
+This software is developed with python 2.7 and some extra modules.
+You need to use one module like:
+ - pie
+
+and you need to install extra dependencies like:
+- flask==1.0.2
+- netifaces==0.10.9
+- psutil==5.6.2
+- bson==0.5.8
+- python-string-utils==0.6.0
+
+### Prerequisites
+
+Install python2.7 - https://www.python.org/download/releases/2.7/
+Install pip - https://pip.pypa.io/en/stable/
+
+
+### Installing
+
+Please, use the following command to install the requirements packages for this project:
+
+```
+pip install -r requirements.txt
+```
+
+## Deployment
+
+
+1. Run the shell script called init.sh
+   
+   or
+
+2. Go to the python folder and run api.py
+
+Navigate to 127.0.0.1:5000 in your browser and the credentials are:
+- admin
+- admin
+
+
+## Built With
+
+* [Flask](http://flask.pocoo.org) - The web framework used
+* [Bootstrap](https://getbootstrap.com/2.3.2/) - Frontend framework
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on my code of conduct, and the process for submitting pull requests to me.
+
+## Versioning
+
+I use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://gitlab.andrealmeida.net/public_projects/vagrant/tags).
+
+## Authors
+
+* **André Almeida** - [andrealmeida.net](https://andrealmeida.net)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+