Skip to content

Commit

Permalink
docs: small usage and doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticspoon committed Jan 27, 2024
1 parent da50a04 commit 30bc1c1
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
/pkg/
/spec/reports/
/tmp/
md_resume-0.1.0.gem
md_resume-*.gem
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,30 @@ gem install md_resume
## Usage

```
Usage: md_resume command filename [options]
Usage: md_resume command filename [options...]
Commands:
serve Start a local server to preview your resume
build Build your resume in html and pdf formats.
generate Generate a template with given name (defaults to markdown)
serve Start a local server to preview your resume
build Build your resume in html and pdf formats.
generate Generate a template with given file name,
defaults to generating only a markdown template.
Specific options:
--chrome-path=PATH Path to Chrome executable
--no-pdf Do not write pdf output
--no-html Do not write html output
-p, --pdf-path=PATH Path of pdf output
-h, --html-path=PATH Path of html output
--css-path=PATH Path of css inputs.
--server-port=PORT Specify the localhost port number for the server
--chrome-path=PATH Path to Chrome executable
--no-pdf Do [not] write pdf output
--[no-]html Do [not] write html output
-p, --pdf-path=PATH Path of pdf output
-h, --html-path=PATH Path of html output
--css-path=PATH Path of css inputs.
--server-port=PORT Specify the localhost port number for the server
--serve-only
-v, --[no-]verbose Run verbosely
--no-open Do not automatically open browser when starting server
-v, --[no-]verbose Run verbosely
--[no-]generate-md Generate markdown template.
--[no-]generate-css Generate CSS template.
Common options:
--help Show this message
--help Show this message
```

## Customization
Expand Down
2 changes: 1 addition & 1 deletion lib/md_resume/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module MdResume
VERSION = '0.1.1'
VERSION = '0.1.2'
end
5 changes: 3 additions & 2 deletions lib/parser.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ def define_options(parser)
parser.separator 'Commands:'
parser.separator "serve\t\t\tStart a local server to preview your resume"
parser.separator "build\t\t\tBuild your resume in html and pdf formats."
parser.separator "generate\t\tGenerate a resume template with the given filename"
parser.separator "generate\t\tGenerate a template with given file name,"
parser.separator "\t\t\tdefaults to generating only a markdown template."
parser.separator ''
parser.separator 'Specific options:'

Expand Down Expand Up @@ -129,7 +130,7 @@ def boolean_open_browser_option(parser)
end

def boolean_generate_md_option(parser)
parser.on('--no-generate-md', 'Do not generate markdown template.') do |v|
parser.on('--[no-]generate-md', 'Generate markdown template.') do |v|
self.generate_md = v
end
end
Expand Down

0 comments on commit 30bc1c1

Please sign in to comment.