APItools Monitor Release 201406111714

CONTRIBUTING.md

@@ -1,7 +1,19 @@
 # Contributing to APItools Traffic Monitor
 
-We would like to accept contributions, but it is not possible as a Pull Requests right now.
+We would very much like to accept your contributions to help improve
+APITools, but at the moment we are not able to accept pull requests to
+this repository.
 
-If you would like to contribute, please contact us first and we can work on it together.
+If you would like to contribute fixes or improvements, please
+[contact us](mailto:[email protected]) and we can work on it
+together. We'll keep a close look at the issues in this repo.
 
-In the future we will open source our whole workflow with our test suite, build scripts and other goodies.
+In the future we will open source our whole workflow with our test
+suite, build scripts and other goodies and be able to accept your pull
+requests directly.
+
+
+# References
+
+- [patches](https://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html)
+  are a nice option to send code via mail.

README.md

@@ -1 +1,43 @@
 # APItools Traffic Monitor
+
+# Install Guide
+You can find the full Install Guide in [our documentation](https://docs.apitools.com/docs/on-premise/).
+
+## Debian/Ubuntu
+
+* For Ubuntu > 13.04 you can use `https://s3.amazonaws.com/apitoolsrepo/packages/ubuntu/13.04/latest`  
+* For Ubuntu 12.04 `https://s3.amazonaws.com/apitoolsrepo/packages/ubuntu/12.04/latest`  
+* For Debian `https://s3.amazonaws.com/apitoolsrepo/packages/debian/7.2/latest`  
+
+```
+wget https://s3.amazonaws.com/apitoolsrepo/packages/ubuntu/12.04/latest -O apitools.deb
+dpkg -i apitools.deb
+```
+
+## OSX
+
+Install [homebrew](http://brew.sh/)
+
+```bash
+brew tap killercup/homebrew-openresty
+brew install ngx_openresty --with-gunzip --with-luajit-checkhook
+brew install luarocks
+
+luarocks install luajson sha2 luaexpat
+```
+
+# Running it
+
+```bash
+nginx -p /path/to/folder -c config/nginx.conf
+```
+
+## OSX
+
+On OSX instead of `nginx` use `openresty`.
+
+
+# Contributing
+
+We can't accept Pull Requests just now.
+For contributing guide check [CONTRIBUTING.md](CONTRIBUTING.md).