diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0d1031c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Craig Johnston - cjimti + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index ec5715b..31aeab1 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ TL;DR? If you are not interested in reading all this you can skip ahead to [Getting Started](#getting-started). IOT Wifi is a [Raspberry Pi] wifi management REST service written in [Go] and -intended to run in a [Docker] container on a Raspberry Pi. +intended to run in a [Docker container on a Raspberry Pi](https://hub.docker.com/r/cjimti/iotwifi/). IOT Wifi sets up network interfaces, runs [hostapd], [wpa_supplicant] and [dnsmasq] to run simultaneously. This allows a user (or another service) to @@ -228,8 +228,8 @@ uap0: flags=4163 mtu 1500 TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0 ``` -The standard wifi interface **wlan0** should be up but no yet -configured since we are not yet connected to an external access point. +The standard wifi interface **wlan0** should be up unconfigured +since we are not yet connected to an external access point. ```plain wlan0: flags=4099 mtu 1500 @@ -380,4 +380,4 @@ you would like added to the project. [IOT]: https://en.wikipedia.org/wiki/Internet_of_things [Docker]: https://www.docker.com/ [Alpine Linux]: https://alpinelinux.org/ -[cjimti/iotwifi]: https://hub.docker.com/r/cjimti/iotwifi/ \ No newline at end of file +[cjimti/iotwifi]: https://hub.docker.com/r/cjimti/iotwifi/