Updates docs and mix.exs

petrovich · Jun 17, 2017 · a60be9b · a60be9b
1 parent 4a8a6cd
commit a60be9b
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # petrovic_elixir
 
-[![petrovich](https://camo.githubusercontent.com/4555ec1b7aa15e0cd22f8ff619c965da0596399a/68747470733a2f2f7261772e6769746875622e636f6d2f726f637363692f706574726f766963682f6d61737465722f706574726f766963682e706e67)](https://github.com/petrovich/petrovich_elixir)
+[![Build Status](https://travis-ci.org/petrovich/petrovich_elixir.svg?branch=master)](https://travis-ci.org/petrovich/petrovich_elixir)[![Coverage Status](https://coveralls.io/repos/github/petrovich/petrovich_elixir/badge.svg?branch=master)](https://coveralls.io/github/petrovich/petrovich_elixir?branch=master)[![petrovich](https://camo.githubusercontent.com/4555ec1b7aa15e0cd22f8ff619c965da0596399a/68747470733a2f2f7261772e6769746875622e636f6d2f726f637363692f706574726f766963682f6d61737465722f706574726f766963682e706e67)](https://github.com/petrovich/petrovich_elixir)
 
 [![Hex Version](https://img.shields.io/hexpm/v/petrovich_elixir.svg)](https://hex.pm/packages/petrovich_elixir) [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
@@ -29,17 +29,28 @@ You need to understand how [grammatical cases](https://en.wikipedia.org/wiki/Gra
 ### API
 
 ```elixir
-PetrovichElixir.firstname("Александр", :accusative, :male)
+Petrovich.firstname("Александр", :accusative, :male)
 # => Александра
 
-PetrovichElixir.middlename("Сергеевич", :accusative, :male)
+Petrovich.middlename("Сергеевич", :accusative, :male)
 # => Сергеевича
 
-PetrovichElixir.lastname("Пушкин", :accusative, :male)
+Petrovich.lastname("Пушкин", :accusative, :male)
 # => Пушкина
 ```
 
 
+## Configuration
+
+You will need to add these lines into your `config.exs`:
+
+```elixir
+config :petrovich_elixir,
+  rules_path: "rules/rules.json",
+  gender_path: "rules/gender.json"
+```
+
+
 ## Rules
 
 This package uses [`petrovich-rules`](https://github.com/petrovich/petrovich-rules) as the source for all transformations. If you ever experience wrong result or other issues with the data itself, please open an issue [here](https://github.com/petrovich/petrovich-rules/issues).

diff --git a/mix.exs b/mix.exs
@@ -1,4 +1,4 @@
-defmodule PetrovichElixir.Mixfile do
+defmodule Petrovich.Mixfile do
   use Mix.Project
 
   @version "0.0.1"