XorA
/
bash-it
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #685 from kigster/search-readme 

Updated README with a section on Search
pull/686/head
Nils Winkler 2016-03-24 08:41:30 +01:00
parent 9fc363037b 50d28364b2
commit fa392e0e18
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -53,6 +53,30 @@ bash-it help completions # shows help for installed completions
bash-it help plugins # shows help for installed plugins
```
## Search
If you need to quickly find out which of the plugins, aliases or completions
are available for a specific task or an environment, you can search for
multiple terms related to the commands you use frequently. Search will
find and output modules with the name or description matching the terms
provided.
```
bash-it search term1 [term2] [term3]....
```
For example, if you are a ruby developer, you might want to enable everything
related to the commands such as `ruby`, `rake`, `gem`, `bundler` and `rails`.
Search command helps you find related modules, so that you can decide which
of them you'd like to use:
```
> bash-it search ruby rake gem bundle irb rails
aliases : bundler rails
plugins : chruby chruby-auto ruby
completions : bundler gem rake
```
## Your Custom scripts, aliases, themes, and functions
For custom scripts, and aliases, just create the following files (they'll be ignored by the git repo):