Update README.md

README.md

@@ -1,24 +1,44 @@
-# Elm Format Number
+# Elm Format Number [![Build Status](https://travis-ci.org/cuducos/elm-format-number.svg?branch=master)](https://travis-ci.org/cuducos/elm-format-number)
 
-[![Build Status](https://travis-ci.org/lovasoa/elm-format-number.svg?branch=master)](https://travis-ci.org/lovasoa/elm-format-number)
 
-This simple [Elm](http://elm-lang.com) package formats numbers as pretty strings.
-It is flexible enough to deal with different number of decimals,
-different thousand separators and diffetent decimal separator.
+This simple [Elm](http://elm-lang.com) package formats `float` numbers as pretty strings:
 
-## API documentation
-The API is extensively documented with numerous examples.
+```elm
+import FormatNumber exposing (format)
+import FormatNumber.Locales exposing (spanishLocale)
 
-See this package's page on elm-lang.org:
-http://package.elm-lang.org/packages/lovasoa/elm-format-number/latest/FormatNumber
+format spanishLocale (pi * 1000)  -- "3.141,59"
+```
+
+It is flexible enough to deal with different number of decimals, different thousand separators and diffetent decimal separator. It has a couple os predefined `Locale` but you can edit them or create your own:
+
+```elm
+import FormatNumber exposing (format)
+import FormatNumber.Locales exposing (Locale)
+
+myLocale : Locale
+myLocale =
+    { decimals = 4
+    , thousandSeparator = " "
+    , decimalSeparator = "."
+    }
+
+sharesLocale : Locale
+sharesLocale = { myLocale | decimals = 3 }
+
+format myLocale (pi * 1000) -- "3 141.5926"
+format sharesLocale (pi * 1000) -- "3 141.593"
+
+
+
+```
+
+The API is further documented in [package.elm-lang.org](http://package.elm-lang.org/packages/cuducos/elm-format-number/latest/FormatNumber).
 
 ## Tests
 
-This package uses [elm-doc-test](https://www.npmjs.com/package/elm-doc-test):
-All the exemples in the documentation are automatically tested and are
-guaranted to be correct.
+This package uses [elm-doc-test](https://www.npmjs.com/package/elm-doc-test), all the exemples in the documentation are automatically tested:
 
-#### launch tests
 ```console
 $ yarn install
 $ yarn test