Packages

Typeracer.com statistics api wrapper

Current section

Files

Jump to
typeracer README.md
Raw

README.md

# Typeracer
This is a wrapper for [Typeracer](http://www.typeracer.com) user statistics API.
## Installation
1. Add `typeracer` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:typeracer, "~> 0.1.0"}]
end
```
2. Ensure `typeracer` is started before your application:
```elixir
def application do
[applications: [:typeracer]]
end
```
## Usage
To get information about a user with id "typeracer" call:
`Typeracer.get_user("typeracer")`
It will return a Typeracer.User struct with useful information.