Add readme, licence and contributing files

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+When wanting to contribute to this repository, please first
+
+* discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository,
+* follow this excelent tutorial on [How To Create a Pull Request on GitHub](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) and
+* acknowledge our Code of Conduct in all your interactions with the project.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENCE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hendrik Maus
+
+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.

README.md

@@ -0,0 +1,70 @@
+# GitHub Traffic - beyond 14 days
+
+[![GitHub release](https://img.shields.io/github/release/M165437/gh-traffic.svg)](https://github.com/M165437/gh-traffic/releases/latest) [![Unstable](https://img.shields.io/badge/unstable-master-orange.svg)](https://github.com/M165437/gh-traffic/tree/master) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat&colorB=458979)](https://github.com/M165437/gh-traffic/blob/master/LICENSE.md) [![Twitter](https://img.shields.io/badge/twitter-@M165437-blue.svg?style=flat&colorB=00aced)](http://twitter.com/M165437)
+
+GitHub shows anyone with push access to a repository its traffic from the past 14 days. What if you need to monitor the traffic beyond those last two weeks?
+
+This Laravel application automatically fetches and persists repository traffic (visitors for now) on an daily basis and plots the data onto a chart.
+
+## Installation
+
+This app is based on Laravel 5.5 and has the same [requirements](https://laravel.com/docs/5.5#server-requirements).
+
+First, clone the application:
+
+``` bash
+git clone https://github.com/M165437/gh-traffic.git
+```
+
+Next, install its dependencies:
+
+``` bash
+composer install
+npm install
+```
+
+Finally, compile its assets:
+
+``` bash
+npm run production
+```
+
+## Configuration
+
+Copy the `.env.example` to `.env` and configure its variables. At the very least, you need to update your database credentials, your [GitHub API key](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) and the repository you want to monitor.
+
+```bash
+GITHUB_API_TOKEN=valid-personal-access-token
+REPOSITORY_OWNER=m165437
+REPOSITORY_NAME=gh-traffic
+```
+
+Use Artisan to set your application key to a random string:
+
+```bash
+php artisan key:generate
+```
+
+For the automatic fetching and persistance of traffic data, you need to add the following Cron entry to your server:
+
+```bash
+* * * * * php /path-to-this-app/artisan schedule:run >> /dev/null 2>&1
+```
+
+## Chart
+
+Visit this app's root domain `/` to see the chart.
+
+![GitHubTraffic](https://i.imgur.com/aclq4mv.png)
+
+## Testing
+
+Run the tests with:
+
+```bash
+vendor/bin/phpunit
+```
+
+## License
+
+This app is licensed under the MIT License (MIT). Please see the [LICENCE](LICENSE.md) file for more information.