Skip to content

Commit

Permalink
add in the man page
Browse files Browse the repository at this point in the history
  • Loading branch information
sdras committed Jul 3, 2021
1 parent 36b6b80 commit f44aa96
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 3 deletions.
31 changes: 31 additions & 0 deletions man/jsexplorer.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.TH "JS" "1" "July 2021" "v1.0.0" "JS Explorer Help"
.SH "NAME"
\fBJS\fR
.QP
.P
Find the method you need without digging through the docs!

.
.SH POSSIBLE COMMANDS
.P
\fBjsexplorer\fP
Runs the explorer tool, allows you to save the entry at the end (optional)
.P
\fBjsexplorer plain\fP
Runs the tool without asking to save at the end
.P
\fBjsexplorer \-p\fP
Same as above, aliased p for plain
.P
\fBlookup [string to look up]\fP
If you save an entry, you can run lookup and the string to find that entry and print it
.P
\fBclearlookup\fP
Clears all jsexplorer saved entries
.SH BUGS
.P
Please report any bugs to https://github\.com/sdras/js\-explorer/issues\.
.SH LICENSE
.P
Copyright (c) 2021, Sarah Drasner (MIT License)\.

11 changes: 10 additions & 1 deletion man_source.md → man/man.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,13 @@ Same as above, aliased p for plain
If you save an entry, you can run lookup and the string to find that entry and print it

`clearlookup`
Clears all jsexplorer saved entries
Clears all jsexplorer saved entries

## BUGS

Please report any bugs to https://github.com/sdras/js-explorer/issues.


## LICENSE

Copyright (c) 2021, Sarah Drasner (MIT License).
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "js-explorer",
"version": "1.0.1",
"version": "1.1.0",
"description": "A terminal-based resource to help you find js methods without digging through the docs",
"main": "bin/index.js",
"bin": {
Expand All @@ -9,7 +9,11 @@
"clearlookup": "./bin/clearLookup.js"
},
"scripts": {
"test": "test"
"test": "test",
"man": "cd man && marked-man --version 'v1.1.0' --manual 'JS Explorer Help' --section 1 man.md > jsexplorer.1"
},
"directories": {
"man": "man"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit f44aa96

Please sign in to comment.