docs(readme): Improve docs

Greentube · Aug 24, 2017 · 02a7676 · 02a7676
1 parent cc86ad7
commit 02a7676
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -7,6 +7,9 @@
 
 - [Installation](#installation)
 - [Usage](#usage)
+  - [Parameters](#parameters)
+  - [Config file](#config-file)
+- [License](#license)
 
 ## Installation
 
@@ -43,5 +46,24 @@ export function HttpLoaderFactory(translate: TranslateService, location: Locatio
 }
 ```
 
+### Config file
+
+JSON config file has following structure:
+```
+{
+    "locales": ["en", "de", ...],
+    "prefix": "MY_PREFIX"
+}
+```
+
+```ts
+interface ILocalizeRouterParserConfig {
+    locales: Array<string>;
+    prefix?: string;
+}
+```
+
+Prefix field is not mandatory and default value is empty string.
+
 ## License
 Licensed under MIT
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "localize-router-http-loader",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A loader for localize-router that loads config using Http",
   "scripts": {
     "clean": "rimraf bundles coverage src/**/*.d.ts src/**/*.metadata.json src/**/*.js tests/**/*.d.ts tests/**/*.metadata.json tests/**/*.js index.d.ts index.metadata.json index.js",