Update docs

Author: tonyganch

README.md

@@ -16,7 +16,8 @@ var Comb = require('csscomb-core');
 var comb = new Comb(options, 'css');
 ```
 
-For a simple example of usage take a look [at a template project](https://github.com/csscomb/core-template).  
+For a simple example of usage take a look
+[at a template project](https://github.com/csscomb/core-template).  
 Feel free to fork it and modify.
 
 ## List of public methods
@@ -60,6 +61,39 @@ Can be used inside plugin's `process` method.
 
 - Return: *{String}*  Syntax name
 
+### comb.lintPath(path)
+
+Lint a file or a directory.
+
+- Params: *{String}*  Path to file or directory</td>
+- Return: *{Promise}*
+
+### comb.lintDirectory(path)
+
+Lint all files in a directory.
+
+- Params: *{String}*  Path to file or directory</td>
+- Return: *{Promise}*
+
+### comb.lintFile(path)
+
+Lint a single file.
+
+- Params: *{String}*  Path to file
+- Return: *{Promise}*
+
+### comb.lintString(string, options)
+
+Lint a string.
+
+- Params:  
+  *{String}*  Code to process  
+  *{{context: String, filename: String, syntax: String}}* Options (optional)
+  where *context* is
+  Gonzales PE rule, *filename* is a file's name that is used to display errors and
+  *syntax* is syntax name with `css` being a default value.  
+- Return: *{Promise<Array>}*  Resolves with list of found errors.  
+
 ### comb.processPath(path)
 
 Process a file or a directory.
@@ -91,7 +125,7 @@ Process a string.
   where *context* is
   Gonzales PE rule, *filename* is a file's name that is used to display errors and
   *syntax* is syntax name with `css` being a default value.  
-- Return: *{String}*  Processed string
+- Return: *{Promise<string>}*  Resolves with processed string.  
 
 ## Writing a plugin
 

src/core.js

@@ -29,6 +29,12 @@ class Comb {
     this.verbose = false;
   }
 
+  /**
+   * Loads configuration from JSON.
+   *
+   * @param {!Object} config
+   * @return {!Comb}
+   */
   configure(config) {
     if (typeof config !== 'object')
       // TODO: throw error
@@ -65,6 +71,8 @@ class Comb {
   }
 
   /**
+   * Lints all files in a directory.
+   *
    * @param {String} path
    * @returns {Promise}
    */
@@ -75,6 +83,8 @@ class Comb {
   }
 
   /**
+   * Lints a single file.
+   *
    * @param {String} path
    * @returns {Promise}
    */
@@ -86,6 +96,8 @@ class Comb {
   }
 
   /**
+   * Lints a file or a directory.
+   *
    * @param {String} path
    */
   lintPath(path) {
@@ -96,6 +108,8 @@ class Comb {
   }
 
   /**
+   * Lints a string.
+   *
    * @param {String} text
    * @param {{context: String, filename: String, syntax: String}} options
    * @returns {Promise} Resolves with <Array> list of found errors.
@@ -183,7 +197,7 @@ class Comb {
    *
    * @param {String} text
    * @param {{context: String, filename: String, syntax: String}} options
-   * @returns {String} Processed string
+   * @returns {Promise<string>} Resolves in processed string
    */
   processString(text, options) {
     return this._parseString(text, options)