Documentation improvements (#34)

* Improve grammar in documentation.

* Fix example, the path is mandatory.

* Demonstrate that applyParams handle arrays of values just fine.

* Also improve example in class documentation.

Author: Emm

api.md

@@ -1,6 +1,6 @@
 # Sitemap
 
-Generate sitemap by [React Router](https://www.npmjs.com/package/react-router) configuration.
+Generate a sitemap using the [React Router](https://www.npmjs.com/package/react-router) configuration.
 
 **Examples**
 
@@ -10,13 +10,13 @@ import Sitemap from 'react-router-sitemap';
 const sitemap = (
   new Sitemap(<Route path='/home'>)
     .build('http://my-site.ru')
-    .save();
+    .save("./sitemap.xml");
 );
 ```
 
 ## constructor
 
-Convert React Router config to array of paths.
+Convert a React Router config to an array of paths.
 
 **Parameters**
 
@@ -32,7 +32,7 @@ const sitemap = new Sitemap(<Route path='/home'>);
 
 ## filterPaths
 
-Filters path on the specified rules.
+Filter paths using the specified rules.
 
 **Parameters**
 
@@ -61,15 +61,15 @@ _Config for include `/auth` and `/thanks`_
 
 ## applyParams
 
-Replaces the dynamic parameters in paths the passed value.
+Replace the dynamic parameters in paths using the given values.
 
 **Parameters**
 
--   `paramsConfig` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)&lt;[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)>** Configuration for replace params.
+-   `paramsConfig` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)&lt;[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)>** Configuration for replacing params.
 
 **Examples**
 
-_Config for replace params `:param` in path `/path/:param`_
+_Config for replacing params `:param` in the path `/path/:param`_
 
 ```javascript
 {
@@ -79,13 +79,13 @@ _Config for replace params `:param` in path `/path/:param`_
 }
 ```
 
-_Config for replace params `:param` and `:subparam`
-in path `/path/:param/:subparam`_
+_Config for replacing params `:param` and `:subparam`
+in the path `/path/:param/:subparam`_
 
 ```javascript
 {
   '/path/:param/:subparam': [
-    { param: 'value', subparam: 'subvalue' }
+    { param: 'value', subparam: ['subvalue1', 'subvalue2'] }
   ]
 }
 ```
@@ -100,15 +100,15 @@ Convert array of paths to sitemap.
 
 ## save
 
-Save sitemap in file.
+Save the sitemap to a file.
 
 **Parameters**
 
 -   `dist` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The path and file name where the sitemap is saved.
 
 # paramsApplier
 
-Module for apply params in dynamic paths.
+Module for applying params in dynamic paths.
 
 **Parameters**
 
@@ -151,7 +151,7 @@ Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refere
 
 # pathsFilter
 
-Module for filter array of paths.
+Module for filtering an array of paths.
 
 **Parameters**
 
@@ -189,7 +189,7 @@ Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refere
 
 # routesParser
 
-Module for parsing result of execute function `createRoutes(<Route>)`
+Module for parsing the result of the `createRoutes(<Route>)` function.
 from [react-router](https://www.npmjs.com/package/react-router) package.
 
 **Parameters**
@@ -221,7 +221,7 @@ Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refere
 
 # sitemapBuilder
 
-Module for build sitemap by array of paths. Using [sitemap](https://www.npmjs.com/package/sitemap) package.
+Module for building a sitemap using an array of paths. Uses the [sitemap](https://www.npmjs.com/package/sitemap) package.
 
 **Parameters**
 
@@ -238,4 +238,4 @@ const hostname = 'http://may-site.ru';
 const sitemap = buildSitemap(hostname, paths);
 ```
 
-Returns **Sitemap** Instance of [Sitemap](https://www.npmjs.com/package/sitemap).
+Returns **Sitemap** instance of [Sitemap](https://www.npmjs.com/package/sitemap).

lib/index.js

@@ -15,7 +15,7 @@ import buildSitemap from './sitemap-builder';
  * const sitemap = (
  *   new Sitemap(<Route path='/home'>)
  *     .build('http://my-site.ru')
- *     .save();
+ *     .save("./sitemap.xml");
  * );
  */
 class Sitemap {
@@ -90,7 +90,7 @@ class Sitemap {
 	 * in path `/path/:param/:subparam`</caption>
 	 * {
 	 *   '/path/:param/:subparam': [
-	 *     { param: 'value', subparam: 'subvalue' }
+	 *     { param: 'value', subparam: ['subvalue1', 'subvalue2'] }
 	 *   ]
 	 * }
 	 *

readme.md

@@ -2,15 +2,15 @@
 
 [![Build Status](https://travis-ci.org/kuflash/react-router-sitemap.svg?branch=master)](https://travis-ci.org/kuflash/react-router-sitemap) [![npm version](https://badge.fury.io/js/react-router-sitemap.svg)](https://badge.fury.io/js/react-router-sitemap)
 
-Module for generate sitemap by [React Router](https://www.npmjs.com/package/react-router) configuration. Also it can filter paths and replace params (like a `:paramName`) in dynamic paths.
+Module for generating sitemaps using [React Router](https://www.npmjs.com/package/react-router) configuration. Also it can filter paths and replace params (like a `:paramName`) in dynamic paths.
 
 ## Install
 
 `npm i --save react-router-sitemap`
 
 ## Usage
 
-You need have module with router configuration. For example:
+You need to have a module with the router configuration. For example:
 
 `router.jsx`
 ```js
@@ -27,7 +27,7 @@ export default (
 	</Route>
 );
 ```
-And need create script which will run from command line or on server.
+And you need to create a script which will run from the command line or on the server.
 
 _Please note that in this case you need a module 'babel-register' to work with the ES2105 syntax and `.jsx` format._
 
@@ -46,13 +46,13 @@ const Sitemap = require('../').default;
 );
 ```
 
-It's minimal example. After running the script next file will be created `sitemap.xml` which included all paths, described configuration `react-router`.
+It's a minimal example. After running the script, a `sitemap.xml` file will be created, which includes all paths, described in the configuration of `react-router`.
 
-More detailed example you can see in the `example` directory. And explore detailed [API](api.md).
+A more detailed example can be found in the `example` directory. You can also explore the details of the [API](api.md).
 
 
 ## [API](api.md)
-Explore public API for usage of module.
+Explore the public API for using the module.
 
 ## License