<commit_before>Laravel GitHub
==============


[![Build Status](https://img.shields.io/travis/GrahamCampbell/Laravel-GitHub/master.svg?style=flat)](https://travis-ci.org/GrahamCampbell/Laravel-GitHub)
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/GrahamCampbell/Laravel-GitHub.svg?style=flat)](https://scrutinizer-ci.com/g/GrahamCampbell/Laravel-GitHub/code-structure)
[![Quality Score](https://img.shields.io/scrutinizer/g/GrahamCampbell/Laravel-GitHub.svg?style=flat)](https://scrutinizer-ci.com/g/GrahamCampbell/Laravel-GitHub)
[![Software License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg?style=flat)](LICENSE.md)
[![Latest Version](https://img.shields.io/github/release/GrahamCampbell/Laravel-GitHub.svg?style=flat)](https://github.com/GrahamCampbell/Laravel-GitHub/releases)


## Introduction

Laravel GitHub was created by, and is maintained by [<NAME>](https://github.com/GrahamCampbell), and is a [PHP GitHub API](https://github.com/KnpLabs/php-github-api) bridge for [Laravel 4.1+](http://laravel.com). It utilises my [Laravel Manager](https://github.com/GrahamCampbell/Laravel-Manager) package. Feel free to check out the [change log](CHANGELOG.md), [releases](https://github.com/GrahamCampbell/Laravel-GitHub/releases), [license](LICENSE.md), [api docs](http://docs.grahamjcampbell.co.uk), and [contribution guidelines](CONTRIBUTING.md).


## Installation

[PHP](https://php.net) 5.4+ or [HHVM](http://hhvm.com) 3.2+, and [Composer](https://getcomposer.org) are required.

To get the latest version of Laravel GitHub, simply require `"graham-campbell/github": "~0.1"` in your `composer.json` file. You'll then need to run `composer install` or `composer update` to download it and have the autoloader updated.

Once Laravel GitHub is installed, you need to register the service provider. Open up `app/config/app.php` and add the following to the `providers` key.

* `'GrahamCampbell\GitHub\GitHubServiceProvider'`

You can register the GitHub facade in the `aliases` key of your `app/config/app.php` file if you like.

* `'GitHub' => 'GrahamCampbell\GitHub\Facades\GitHub'`


## Configuration

Laravel GitHub requires connection configuration.

To get started, first publish the package config file:

```bash
$ php artisan config:publish graham-campbell/github
```<commit_msg>Updated the badges<commit_after>Laravel GitHub
==============


[![Build Status](https://img.shields.io/travis/GrahamCampbell/Laravel-GitHub/master.svg?style=flat-square)](https://travis-ci.org/GrahamCampbell/Laravel-GitHub)
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/GrahamCampbell/Laravel-GitHub.svg?style=flat-square)](https://scrutinizer-ci.com/g/GrahamCampbell/Laravel-GitHub/code-structure)
[![Quality Score](https://img.shields.io/scrutinizer/g/GrahamCampbell/Laravel-GitHub.svg?style=flat-square)](https://scrutinizer-ci.com/g/GrahamCampbell/Laravel-GitHub)
[![Software License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Latest Version](https://img.shields.io/github/release/GrahamCampbell/Laravel-GitHub.svg?style=flat-square)](https://github.com/GrahamCampbell/Laravel-GitHub/releases)


## Introduction

Laravel GitHub was created by, and is maintained by [<NAME>](https://github.com/GrahamCampbell), and is a [PHP GitHub API](https://github.com/KnpLabs/php-github-api) bridge for [Laravel 4.1+](http://laravel.com). It utilises my [Laravel Manager](https://github.com/GrahamCampbell/Laravel-Manager) package. Feel free to check out the [change log](CHANGELOG.md), [releases](https://github.com/GrahamCampbell/Laravel-GitHub/releases), [license](LICENSE.md), [api docs](http://docs.grahamjcampbell.co.uk), and [contribution guidelines](CONTRIBUTING.md).


## Installation

[PHP](https://php.net) 5.4+ or [HHVM](http://hhvm.com) 3.2+, and [Composer](https://getcomposer.org) are required.

To get the latest version of Laravel GitHub, simply require `"graham-campbell/github": "~0.1"` in your `composer.json` file. You'll then need to run `composer install` or `composer update` to download it and have the autoloader updated.

Once Laravel GitHub is installed, you need to register the service provider. Open up `app/config/app.php` and add the following to the `providers` key.

* `'GrahamCampbell\GitHub\GitHubServiceProvider'`

You can register the GitHub facade in the `aliases` key of your `app/config/app.php` file if you like.

* `'GitHub' => 'GrahamCampbell\GitHub\Facades\GitHub'`


## Configuration

Laravel GitHub requires connection configuration.

To get started, first publish the package config file:

```bash
$ php artisan config:publish graham-campbell/github
```
{'fraction_non_alphanumeric': 0.15575860603484912, 'fraction_numerical': 0.005099872503187421, 'mean_word_length': 5.743553008595988, 'pattern_counts': {'":': 2, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 30, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1104798', 'n_tokens_mistral': 1686, 'n_tokens_neox': 1539, 'n_words': 324}