diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a49d3714 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +## How to contribute + +1. File an issue in the repository, using the bug tracker, describing the + contribution you'd like to make. This will help us to get you started on the + right foot. +2. Fork the project in your account and create a new branch: + `your-great-feature`. +3. Commit your changes in that branch. +4. Open a pull request, and reference the initial issue in the pull request + message. diff --git a/README.md b/README.md index 0c6ed044..653824e2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![](http://i.imgur.com/xeKD93p.png) # `$ raspap-webgui` [![Release 1.2.1](https://img.shields.io/badge/Release-1.2.1-green.svg)](https://github.com/billz/raspap-webgui/releases) -A simple, responsive web interface t:o control wifi, hostapd and related services on the Raspberry Pi. +A simple, responsive web interface to control wifi, hostapd and related services on the Raspberry Pi. This project was inspired by a [**blog post**](http://sirlagz.net/2013/02/06/script-web-configuration-page-for-raspberry-pi/) by SirLagz about using a web page rather than ssh to configure wifi and hostapd settings on the Raspberry Pi. I mostly just prettified the UI by wrapping it in [**SB Admin 2**](https://github.com/BlackrockDigital/startbootstrap-sb-admin-2), a Bootstrap based admin theme.