c481c62bc996cfe22417621dfd96c4267eb1e740

Message

Refactor and clear up README file

Diff

This diff is truncated to protect this page.

  1diff --git a/plugins/frontend-search/README.md b/plugins/frontend-search/README.md
  2index bf8a4bc0839bb9d1b98268ac7df735db3d1a15a7..d0bc5589f742e2dd3081242f2811b69d0571bff4 100644
  3--- a/plugins/frontend-search/README.md
  4+++ b/plugins/frontend-search/README.md
  5@@ -1,83 +1,60 @@
  6-## Rationale ##
  7+## Introduction ##
  8 
  9-> Searches for your Frontend contents more easier
 10+> Searches for your frontend web development made easier
 11 
 12 
 13-## Instalation ##
 14+## Installation ##
 15 
 16+Open your `~/.zshrc` file and enable the `frontend-search` plugin:
 17 
 18-Open your `.zshrc` file and load `frontend-search` plugin
 19+```zsh
 20+
 21+plugins=( ... frontend-search)
 22 
 23-```bash
 24-...
 25-plugins=( <your-plugins-list>... frontend-search)
 26-...
 27 ```
 28 
 29 
 30-## Commands ##
 31-
 32-All command searches are accept only in formats
 33-
 34-* `frontend <search-content> <search-term>`
 35-* `<search-content> <search-term>`
 36-
 37-For more informations, please run help command (are similars)
 38-
 39-* `frontend -h`
 40-* `frontend --help`
 41-* `frontend help`
 42-
 43-The search content are
 44-
 45-* `jquery <api.jquery.com>`
 46-* `mdn <developer.mozilla.org>`
 47-* `compass <compass-style.org>`
 48-* `html5please <html5please.com>`
 49-* `caniuse <caniuse.com>`
 50-* `aurajs <aurajs.com>`
 51-* `dartlang <api.dartlang.org/apidocs/channels/stable/dartdoc-viewer>`
 52-* `lodash <search>`
 53-* `qunit <api.qunitjs.com>`
 54-* `fontello <fontello.com>`
 55-* `bootsnipp <bootsnipp.com>`
 56-* `cssflow <cssflow.com>`
 57-* `codepen <codepen.io>`
 58-* `unheap <www.unheap.com>`
 59-* `bem <google.com/search?as_q=<search-term>&as_sitesearch=bem.info>`
 60-* `smacss <google.com/search?as_q=<search-term>&as_sitesearch=smacss.com>`
 61-* `angularjs <google.com/search?as_q=<search-term>&as_sitesearch=angularjs.org>`
 62-* `reactjs <google.com/search?as_q=<search-term>&as_sitesearch=facebook.github.io/react>`
 63-* `emberjs <emberjs.com>`
 64-* `stackoverflow <stackoverflow.com>`
 65-* `npmjs <npmjs.com>`
 66-
 67-
 68-## Aliases ##
 69-
 70-There are a few aliases presented as well:
 71-
 72-* `jquery` A shorthand for `frontend jquery`
 73-* `mdn` A shorthand for `frontend mdn`
 74-* `compass` A shorthand for `frontend compass`
 75-* `html5please` A shorthand for `frontend html5please`
 76-* `caniuse` A shorthand for `frontend caniuse`
 77-* `aurajs` A shorthand for `frontend aurajs`
 78-* `dartlang` A shorthand for `frontend dartlang`
 79-* `lodash` A shorthand for `frontend lodash`
 80-* `qunit` A shorthand for `frontend qunit`
 81-* `fontello` A shorthand for `frontend fontello`
 82-* `bootsnipp` A shorthand for `frontend bootsnipp`
 83-* `cssflow` A shorthand for `frontend cssflow`
 84-* `codepen` A shorthand for `frontend codepen`
 85-* `unheap` A shorthand for `frontend unheap`
 86-* `bem` A shorthand for `frontend bem`
 87-* `smacss` A shorthand for `frontend smacss`
 88-* `angularjs` A shorthand for `frontend angularjs`
 89-* `reactjs` A shorthand for `frontend reactjs`
 90-* `emberjs` A shorthand for `frontend emberjs`
 91-* `stackoverflow` A shorthand for `frontend stackoverflow`
 92-* `npmjs` A shorthand for `frontend npmjs`
 93+## Usage ##
 94+
 95+You can use the frontend-search plugin in these two forms:
 96+
 97+* `frontend <context> <term> [more terms if you want]`
 98+* `<context> <term> [more terms if you want]`
 99+
100+For example, these two are equivalent:
101+
102+```zsh
103+$ frontend angularjs dependency injection
104+$ angularjs dependency injection