<commit_before># Kindred

Kindred is a thin Node.js wrapper (with an optional rate limiter) on top of [Riot Games API for League of Legends](http://www.developer.riotgames.com).

## Table of Contents
* [Philosophy](#philosophy)
* [Installation](#installation)
* [Endpoints Covered](#endpoints-covered)
* [Usage](#usage)
* [Contributing and Issues](#contributing-and-issues)

## Philosophy
My goal is to make a wrapper that is simple, sensible, and consistent. This project is heavily inspired by [psuedonym117's Python wrapper](https://github.com/pseudonym117/Riot-Watcher). Look at the [Quick Usage Examples](#quick-usage-examples) to see what I mean.

This is my first try at making an API wrapper. I am open to any advice and help!

***March 28, 2017***

**I'm pretty proud of the end result. The rate limiting isn't the best, but it does work and is enforced per region! Also, the method names are kinda iffy (minor inconsistencies), but it works really well for my other project and for when I need a quick script. I'll try to improve this library over the next few weeks.**

## Installation
```
yarn add kindred-api
// or npm install kindred-api
```

## Endpoints Covered
Make sure to check the [official Riot Documentation](https://developer.riotgames.com/api-methods/) to see what query parameters you can pass in to each endpoint (through the options parameter)!

Note: All ```region``` parameters are **OPTIONAL**. All ```options``` parameters are **OPTIONAL** unless stated otherwise.

* [CHAMPION-V1.2](#champion)
* [CHAMPIONMASTERY](#champion-mastery)
* [CURRENT-GAME-V1.0](#current-game)
* [FEATURED-GAMES-V1.0](#featured-games)
* [GAME-V1.3](#game)
* [LEAGUE-V2.5](#league)
* [LOL-STATIC-DATA-V1.2](#lol-static-data)
* [LOL-STATUS-V1.0](#lol-status)<commit_msg>Usage section jump fix<commit_after># Kindred

Kindred is a thin Node.js wrapper (with an optional rate limiter) on top of [Riot Games API for League of Legends](http://www.developer.riotgames.com).

## Table of Contents
* [Philosophy](#philosophy)
* [Installation](#installation)
* [Endpoints Covered](#endpoints-covered)
* [Usage](#usage)
* [Contributing and Issues](#contributing-and-issues)

## Philosophy
My goal is to make a wrapper that is simple, sensible, and consistent. This project is heavily inspired by [psuedonym117's Python wrapper](https://github.com/pseudonym117/Riot-Watcher). Look at the [Usage Section](#usage) to see what I mean.

This is my first try at making an API wrapper. I am open to any advice and help!

***March 28, 2017***

**I'm pretty proud of the end result. The rate limiting isn't the best, but it does work and is enforced per region! Also, the method names are kinda iffy (minor inconsistencies), but it works really well for my other project and for when I need a quick script. I'll try to improve this library over the next few weeks.**

## Installation
```
yarn add kindred-api
// or npm install kindred-api
```

## Endpoints Covered
Make sure to check the [official Riot Documentation](https://developer.riotgames.com/api-methods/) to see what query parameters you can pass in to each endpoint (through the options parameter)!

Note: All ```region``` parameters are **OPTIONAL**. All ```options``` parameters are **OPTIONAL** unless stated otherwise.

* [CHAMPION-V1.2](#champion)
* [CHAMPIONMASTERY](#champion-mastery)
* [CURRENT-GAME-V1.0](#current-game)
* [FEATURED-GAMES-V1.0](#featured-games)
* [GAME-V1.3](#game)
* [LEAGUE-V2.5](#league)
* [LOL-STATIC-DATA-V1.2](#lol-static-data)
* [LOL-STATUS-V1.0](#lol-status)
{'fraction_non_alphanumeric': 0.12884995761514553, 'fraction_numerical': 0.01469341621927098, 'mean_word_length': 4.96964586846543, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2290101', 'n_tokens_mistral': 1179, 'n_tokens_neox': 1081, 'n_words': 409}