git » gofer » commit 7c766f2

Add LICENSE and README

author Alberto Bertogli
2020-06-10 22:20:02 UTC
committer Alberto Bertogli
2020-06-10 22:20:02 UTC
parent d5c8f6fe710d70ef2433e3fd31dd576e4af1c401

Add LICENSE and README

LICENSE +25 -0
README.md +36 -0

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ce56d78
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,25 @@
+gofer is under the MIT licence, which is reproduced below (taken from
+http://opensource.org/licenses/MIT).
+
+-----
+
+Copyright (c)  Alberto Bertogli
+
+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
new file mode 100644
index 0000000..f974ac3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+
+# gofer
+
+[gofer](https://blitiri.com.ar/git/r/gofer) is a small web server and reverse
+proxy.
+
+
+## Status
+
+Gofer is under active development, so breaking changes are expected.
+
+It is fully functional and being used to serve some small websites.
+Performance for serving static files is comparable with a default nginx
+configuration.
+
+
+## Install
+
+gofer is written in Go.
+
+```sh
+go get blitiri.com.ar/go/gofer
+```
+
+
+## Configure
+
+See the [sample config](etc/gofer.yaml) for details on how to configure gofer,
+and what features are available.
+
+
+## Contact
+
+If you have any questions, comments or patches please send them to
+albertito@blitiri.com.ar.
+