update README

Author: Leopoldthecoder

README.md

@@ -1,25 +1,48 @@
 # PostCSS Hsl Color Function
 
 [PostCSS] plugin to transform HSL color function to more compatible CSS.
+Inspired and modified from [postcss-sass-color-functions].
 
 [PostCSS]: https://github.com/postcss/postcss
+[postcss-sass-color-functions]: https://github.com/adam-h/postcss-sass-color-functions
+
+## Installation
+
+```console
+$ npm install postcss-hsl-color-function
+```
+
+## Usage
+
+```js
+postcss([require('postcss-hsl-color-function')])
+```
+
+Before:
 
 ```css
 .foo {
   color: hue(red, 120)
 }
 ```
 
+After:
+
 ```css
 .foo {
   color: rgb(0, 255, 0)
 }
 ```
 
-## Usage
+Checkout [test.js](index.test.js) for examples.
 
-```js
-postcss([ require('postcss-hsl-color-function') ])
-```
+### Currently supported functions
+
+- `hue(color, degree)`
+- `saturation(color, percentage)`
+- `lightness(color, percentage)`
 
-See [PostCSS] docs for examples for your environment.
+and their aliases:
+- `h(color, degree)`
+- `s(color, percentage)`
+- `l(color, percentage)`

index.js

@@ -61,10 +61,8 @@ function transformColor(string, source) {
     return string
   }
   var index = match.index
-  var sassFn = match[2]
+  var hslFn = match[2]
 
-  // NOTE: regexp search beginning of line of non char symbol before `FUNCTION(`.
-  //       Offset used for second case.
   index = index === 0 ? index : index + 1
 
   var fn = string.slice(index)
@@ -74,6 +72,6 @@ function transformColor(string, source) {
   }
 
   return string.slice(0, index) +
-    functions[sassFn].apply(null, balancedMatches.body.split(/,(?![^\(]*\))/)) +
+    functions[hslFn].apply(null, balancedMatches.body.split(/,(?![^\(]*\))/)) +
     transformColor(balancedMatches.post, source)
 }

index.test.js

@@ -1,9 +1,8 @@
 var postcss = require('postcss')
-
 var plugin = require('./')
 
 function run(input, output) {
-  return postcss([plugin()]).process(input).then(result => {
+  return postcss([plugin()]).process(input).then(function(result) {
     expect(result.css).toEqual(output)
     expect(result.warnings().length).toBe(0)
   })

package.json

@@ -29,7 +29,7 @@
     "jest": "^18.0.0"
   },
   "scripts": {
-    "lint": "node_modules/.bin/eslint *.js",
+    "lint": "node_modules/.bin/eslint index.js",
     "test": "jest",
     "pub": "sh release.sh"
   }