Refactor and clear up README file

plugins/frontend-search/README.md

@@ -1,83 +1,60 @@
-## Rationale ##
+## Introduction ##
 
-> Searches for your Frontend contents more easier
+> Searches for your frontend web development made easier
 
 
-## Instalation ##
+## Installation ##
 
+Open your `~/.zshrc` file and enable the `frontend-search` plugin:
 
-Open your `.zshrc` file and load `frontend-search` plugin
+```zsh
+
+plugins=( ... frontend-search)
 
-```bash
-...
-plugins=( <your-plugins-list>... frontend-search)
-...
 ```
 
 
-## Commands ##
+## Usage ##
 
-All command searches are accept only in formats
+You can use the frontend-search plugin in these two forms:
 
-* `frontend <search-content> <search-term>`
-* `<search-content> <search-term>`
+* `frontend <context> <term> [more terms if you want]`
+* `<context> <term> [more terms if you want]`
 
-For more informations, please run help command (are similars)
+For example, these two are equivalent:
 
-* `frontend -h`
-* `frontend --help`
-* `frontend help`
+```zsh
+$ frontend angularjs dependency injection
+$ angularjs dependency injection
+```
 
-The search content are
+Available search contexts are:
 
-* `jquery <api.jquery.com>`
-* `mdn <developer.mozilla.org>`
-* `compass <compass-style.org>`
-* `html5please <html5please.com>`
-* `caniuse <caniuse.com>`
-* `aurajs <aurajs.com>`
-* `dartlang <api.dartlang.org/apidocs/channels/stable/dartdoc-viewer>`
-* `lodash <search>`
-* `qunit <api.qunitjs.com>`
-* `fontello <fontello.com>`
-* `bootsnipp <bootsnipp.com>`
-* `cssflow <cssflow.com>`
-* `codepen <codepen.io>`
-* `unheap <www.unheap.com>`
-* `bem <google.com/search?as_q=<search-term>&as_sitesearch=bem.info>`
-* `smacss <google.com/search?as_q=<search-term>&as_sitesearch=smacss.com>`
-* `angularjs <google.com/search?as_q=<search-term>&as_sitesearch=angularjs.org>`
-* `reactjs <google.com/search?as_q=<search-term>&as_sitesearch=facebook.github.io/react>`
-* `emberjs <emberjs.com>`
-* `stackoverflow <stackoverflow.com>`
-* `npmjs <npmjs.com>`
+| context       | URL                                                                      |
+|---------------|--------------------------------------------------------------------------|
+| angularjs     | `https://google.com/search?as_sitesearch=angularjs.org&as_q=`            |
+| aurajs        | `http://aurajs.com/api/#stq=`                                            |
+| bem           | `https://google.com/search?as_sitesearch=bem.info&as_q=`                 |
+| bootsnipp     | `http://bootsnipp.com/search?q=`                                         |
+| caniuse       | `http://caniuse.com/#search=`                                            |
+| codepen       | `http://codepen.io/search?q=`                                            |
+| compass       | `http://compass-style.org/search?q=`                                     |
+| cssflow       | `http://www.cssflow.com/search?q=`                                       |
+| dartlang      | `https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/dart:`  |
+| emberjs       | `http://emberjs.com/api/#stp=1&stq=`                                     |
+| fontello      | `http://fontello.com/#search=`                                           |
+| html5please   | `http://html5please.com/#`                                               |
+| jquery        | `https://api.jquery.com/?s=`                                             |
+| lodash        | `https://devdocs.io/lodash/index#`                                       |
+| mdn           | `https://developer.mozilla.org/search?q=`                                |
+| npmjs         | `https://www.npmjs.com/search?q=`                                        |
+| qunit         | `https://api.qunitjs.com/?s=`                                            |
+| reactjs       | `https://google.com/search?as_sitesearch=facebook.github.io/react&as_q=` |
+| smacss        | `https://google.com/search?as_sitesearch=smacss.com&as_q=`               |
+| stackoverflow | `http://stackoverflow.com/search?q=`                                     |
+| unheap        | `http://www.unheap.com/?s=`                                              |
 
-
-## Aliases ##
-
-There are a few aliases presented as well:
-
-* `jquery` A shorthand for `frontend jquery`
-* `mdn` A shorthand for `frontend mdn`
-* `compass` A shorthand for `frontend compass`
-* `html5please` A shorthand for `frontend html5please`
-* `caniuse` A shorthand for `frontend caniuse`
-* `aurajs` A shorthand for `frontend aurajs`
-* `dartlang` A shorthand for `frontend dartlang`
-* `lodash` A shorthand for `frontend lodash`
-* `qunit` A shorthand for `frontend qunit`
-* `fontello` A shorthand for `frontend fontello`
-* `bootsnipp` A shorthand for `frontend bootsnipp`
-* `cssflow` A shorthand for `frontend cssflow`
-* `codepen` A shorthand for `frontend codepen`
-* `unheap` A shorthand for `frontend unheap`
-* `bem` A shorthand for `frontend bem`
-* `smacss` A shorthand for `frontend smacss`
-* `angularjs` A shorthand for `frontend angularjs`
-* `reactjs` A shorthand for `frontend reactjs`
-* `emberjs` A shorthand for `frontend emberjs`
-* `stackoverflow` A shorthand for `frontend stackoverflow`
-* `npmjs` A shorthand for `frontend npmjs`
+If you want to have another context, open an Issue and tell us!
 
 
 ## Author
@@ -86,5 +63,3 @@ There are a few aliases presented as well:
 + <https://plus.google.com/+WilsonMendes>
 + <https://twitter.com/willmendesneto>
 + <http://github.com/willmendesneto>
-
-New features comming soon.