-
Notifications
You must be signed in to change notification settings - Fork 214
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(readme): manpm can show and search README.md in the current fold…
…er, closes #20
- Loading branch information
Showing
2 changed files
with
29 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,7 +33,7 @@ for both variants: words or unicode symbols | |
|
||
npm install -g manpm | ||
|
||
## Show entire package or github readme | ||
## Show the entire README from a package or github repo | ||
|
||
You can give NPM package name (like `manpm`), GitHub user / repo pair (like `bahmutov/manpm`) or | ||
full GitHub url (like `https://github.com/bahmutov/object-fitter` or `[email protected]:bahmutov/object-fitter.git`). | ||
|
@@ -64,6 +64,12 @@ The following search features are implemented | |
I am still looking for a library capable of fuzzy text search. | ||
Maybe [lunr](https://github.com/olivernn/lunr.js)? | ||
|
||
## Show and search local README | ||
|
||
Sometimes you just want to find a section in the local README file, right in the current directory. | ||
|
||
manpm . [optional search text] | ||
|
||
## Example: showing ES6 docs | ||
|
||
There is a great GitHub repo [ES6 Overview in 350 Bullet Points](https://github.com/bevacqua/es6) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters