mirror of
https://github.com/JuanCanham/HackMyResume.git
synced 2024-11-05 09:56:22 +00:00
Document PEEK command.
Add preliminary docs around PEEK.
This commit is contained in:
parent
fff45e1431
commit
88879257e6
85
README.md
85
README.md
@ -107,7 +107,7 @@ Use it when you need to submit, upload, print, or email resumes in specific
|
|||||||
formats.
|
formats.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# hackmyresume BUILD <INPUTS> TO <OUTPUTS> [-t THEME]
|
# hackmyresume BUILD <INPUTS...> TO <OUTPUTS...> [-t THEME]
|
||||||
hackmyresume BUILD resume.json TO out/resume.all
|
hackmyresume BUILD resume.json TO out/resume.all
|
||||||
hackmyresume BUILD r1.json r2.json TO out/rez.html out/rez.md foo/rez.all
|
hackmyresume BUILD r1.json r2.json TO out/rez.html out/rez.md foo/rez.all
|
||||||
```
|
```
|
||||||
@ -115,7 +115,7 @@ formats.
|
|||||||
- **new** creates a new resume in FRESH or JSON Resume format.
|
- **new** creates a new resume in FRESH or JSON Resume format.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# hackmyresume NEW <OUTPUTS> [-f <FORMAT>]
|
# hackmyresume NEW <OUTPUTS...> [-f <FORMAT>]
|
||||||
hackmyresume NEW resume.json
|
hackmyresume NEW resume.json
|
||||||
hackmyresume NEW resume.json -f fresh
|
hackmyresume NEW resume.json -f fresh
|
||||||
hackmyresume NEW r1.json r2.json -f jrs
|
hackmyresume NEW r1.json r2.json -f jrs
|
||||||
@ -123,12 +123,18 @@ formats.
|
|||||||
|
|
||||||
- **analyze** inspects your resume for keywords, duration, and other metrics.
|
- **analyze** inspects your resume for keywords, duration, and other metrics.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# hackmyresume ANALYZE <INPUTS...>
|
||||||
|
hackmyresume ANALYZE resume.json
|
||||||
|
hackmyresume ANALYZE r1.json r2.json
|
||||||
|
```
|
||||||
|
|
||||||
- **convert** converts your source resume between FRESH and JSON Resume
|
- **convert** converts your source resume between FRESH and JSON Resume
|
||||||
formats. Use it to convert between the two formats to take advantage of tools
|
formats. Use it to convert between the two formats to take advantage of tools
|
||||||
and services.
|
and services.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# hackmyresume CONVERT <INPUTS> TO <OUTPUTS>
|
# hackmyresume CONVERT <INPUTS...> TO <OUTPUTS...>
|
||||||
hackmyresume CONVERT resume.json TO resume-jrs.json
|
hackmyresume CONVERT resume.json TO resume-jrs.json
|
||||||
hackmyresume CONVERT 1.json 2.json 3.json TO out/1.json out/2.json out/3.json
|
hackmyresume CONVERT 1.json 2.json 3.json TO out/1.json out/2.json out/3.json
|
||||||
```
|
```
|
||||||
@ -137,11 +143,22 @@ and services.
|
|||||||
Resume schema. Use it to make sure your resume data is sufficient and complete.
|
Resume schema. Use it to make sure your resume data is sufficient and complete.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# hackmyresume VALIDATE <INPUTS>
|
# hackmyresume VALIDATE <INPUTS...>
|
||||||
hackmyresume VALIDATE resume.json
|
hackmyresume VALIDATE resume.json
|
||||||
hackmyresume VALIDATE r1.json r2.json r3.json
|
hackmyresume VALIDATE r1.json r2.json r3.json
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- **peek** echoes your resume or any field, property, or object path on your
|
||||||
|
resume to standard output.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# hackmyresume PEEK <INPUTS...> [OBJECT-PATH]
|
||||||
|
hackmyresume PEEK rez.json # Echo the whole resume
|
||||||
|
hackmyresume PEEK rez.json info.brief # Echo the "info.brief" field
|
||||||
|
hackmyresume PEEK rez.json employment.history[1] # Echo the 1st job
|
||||||
|
hackmyresume PEEK rez.json rez2.json info.brief # Compare value
|
||||||
|
```
|
||||||
|
|
||||||
## Supported Output Formats
|
## Supported Output Formats
|
||||||
|
|
||||||
HackMyResume supports these output formats:
|
HackMyResume supports these output formats:
|
||||||
@ -209,24 +226,36 @@ Generating YAML resume: out/resume.yml
|
|||||||
|
|
||||||
### Applying a theme
|
### Applying a theme
|
||||||
|
|
||||||
HackMyResume can work with any FRESH or JSON Resume theme. To specify a theme
|
HackMyResume can work with any FRESH or JSON Resume theme (the latter must be
|
||||||
when generating your resume, use the `-t` or `--theme` parameter:
|
installed first). To specify a theme when generating your resume, use the `-t`
|
||||||
|
or `--theme` parameter:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hackmyresume BUILD resume.json TO out/rez.all -t [theme]
|
hackmyresume BUILD resume.json TO out/rez.all -t [theme]
|
||||||
```
|
```
|
||||||
|
|
||||||
The `[theme]` parameter can be the name of a predefined theme or the path to any
|
The `[theme]` parameter can be the name of a predefined theme OR the path to any
|
||||||
FRESH or JSON Resume theme folder:
|
FRESH or JSON Resume theme folder:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hackmyresume BUILD resume.json TO out/rez.all -t modern
|
hackmyresume BUILD resume.json TO out/rez.all -t modern
|
||||||
hackmyresume BUILD resume.json TO OUT.rez.all -t ../some-folder/my-custom-theme/
|
hackmyresume BUILD resume.json TO OUT.rez.all -t ../some-folder/my-custom-theme/
|
||||||
hackmyresume BUILD resume.json TO OUT.rez.all -t npm_modules/jsonresume-theme-classy
|
hackmyresume BUILD resume.json TO OUT.rez.all -t node_modules/jsonresume-theme-classy
|
||||||
```
|
```
|
||||||
|
|
||||||
As of v1.4.0, available predefined themes are `positive`, `modern`, `compact`,
|
FRESH themes are currently pre-installed with HackMyResume. JSON Resume themes
|
||||||
`minimist`, and `hello-world`.
|
can be installed prior to use:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install a JSON Resume theme into a local node_modules subfolder:
|
||||||
|
npm install jsonresume-theme-[name]
|
||||||
|
# Use it with HackMyResume
|
||||||
|
hackmyresume build resume.json -t node_modules/jsonresume-theme-[name]
|
||||||
|
```
|
||||||
|
|
||||||
|
As of v1.6.0, available predefined FRESH themes are `positive`, `modern`,
|
||||||
|
`compact`, `minimist`, and `hello-world`. For a list of JSON Resume themes,
|
||||||
|
check the [NPM Registry](https://www.npmjs.com/search?q=jsonresume-theme).
|
||||||
|
|
||||||
### Merging resumes
|
### Merging resumes
|
||||||
|
|
||||||
@ -281,6 +310,9 @@ hackmyresume BUILD me.json TO out/resume.all
|
|||||||
|
|
||||||
### Building PDFs
|
### Building PDFs
|
||||||
|
|
||||||
|
*Users who don't care about PDFs can turn off PDF generation across all themes
|
||||||
|
and formats with the `--pdf none` switch.*
|
||||||
|
|
||||||
HackMyResume takes a unique approach to PDF generation. Instead of enforcing
|
HackMyResume takes a unique approach to PDF generation. Instead of enforcing
|
||||||
a specific PDF engine on users, HackMyResume will attempt to work with whatever
|
a specific PDF engine on users, HackMyResume will attempt to work with whatever
|
||||||
PDF engine you have installed through the engine's command-line interface (CLI).
|
PDF engine you have installed through the engine's command-line interface (CLI).
|
||||||
@ -289,10 +321,10 @@ Currently that means one or both of...
|
|||||||
- [wkhtmltopdf][3]
|
- [wkhtmltopdf][3]
|
||||||
- [Phantom.js][3]
|
- [Phantom.js][3]
|
||||||
|
|
||||||
..with support for other engines planned in the future. **One or both of these
|
..with support for other engines planned in the future. But for now, **one or
|
||||||
engines must be installed and accessible on your PATH in order to generate PDF
|
both of these engines must be installed and accessible on your PATH in order to
|
||||||
resumes with HackMyResume**. That means you should be able to invoke either of
|
generate PDF resumes with HackMyResume**. That means you should be able to
|
||||||
these tools directly from your shell or terminal without error:
|
invoke either of these tools directly from your shell or terminal without error:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
wkhtmltopdf input.html output.pdf
|
wkhtmltopdf input.html output.pdf
|
||||||
@ -437,10 +469,17 @@ where <INPUTS> is one or more resumes in FRESH or JSON Resume format, and
|
|||||||
autodetect the format (FRESH or JRS) of each input resume and convert it to the
|
autodetect the format (FRESH or JRS) of each input resume and convert it to the
|
||||||
other format (JRS or FRESH).
|
other format (JRS or FRESH).
|
||||||
|
|
||||||
### External options
|
### File-based Options
|
||||||
|
|
||||||
Starting in v1.4.x you can pass options into HackMyResume via an external
|
You can pass options into HackMyResume via an external options or ".hackmyrc"
|
||||||
options or ".hackmyrc" file.
|
file with the `--options` or `-o` switch:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hackmyresume BUILD resume.json -o path/to/options.json
|
||||||
|
```
|
||||||
|
|
||||||
|
The options file can contain any documented HackMyResume option, including
|
||||||
|
`theme`, `silent`, `debug`, `pdf`, `css`, and other settings.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
{
|
{
|
||||||
@ -453,6 +492,18 @@ options or ".hackmyrc" file.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If a particular option is specified both on the command line and in an external
|
||||||
|
options file, the explicit command-line option takes precedence.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# path/to/options.json specifes the POSITIVE theme
|
||||||
|
# -t parameter specifies the COMPACT theme
|
||||||
|
# The -t parameter wins.
|
||||||
|
hackmyresume BUILD resume.json -o path/to/options.json -t compact
|
||||||
|
> Reading resume: resume.json
|
||||||
|
> Applying COMPACT theme (7 formats)
|
||||||
|
```
|
||||||
|
|
||||||
### Prettifying
|
### Prettifying
|
||||||
|
|
||||||
HackMyResume applies [js-beautify][10]-style HTML prettification by default to
|
HackMyResume applies [js-beautify][10]-style HTML prettification by default to
|
||||||
|
@ -9,6 +9,7 @@ Available commands:
|
|||||||
VALIDATE Validate your resume for errors and typos.
|
VALIDATE Validate your resume for errors and typos.
|
||||||
CONVERT Convert your resume between FRESH and JSON Resume.
|
CONVERT Convert your resume between FRESH and JSON Resume.
|
||||||
NEW Create a new resume in FRESH or JSON Resume format.
|
NEW Create a new resume in FRESH or JSON Resume format.
|
||||||
|
PEEK View a specific field or element on your resume.
|
||||||
|
|
||||||
Available options:
|
Available options:
|
||||||
|
|
||||||
@ -33,6 +34,7 @@ Examples:
|
|||||||
hackmyresume NEW my-new-resume.json --format JRS
|
hackmyresume NEW my-new-resume.json --format JRS
|
||||||
hackmyresume CONVERT resume-fresh.json TO resume-jrs.json
|
hackmyresume CONVERT resume-fresh.json TO resume-jrs.json
|
||||||
hackmyresume VALIDATE resume.json
|
hackmyresume VALIDATE resume.json
|
||||||
|
hackmyresume PEEK resume.json employment[2].summary
|
||||||
|
|
||||||
Tips:
|
Tips:
|
||||||
|
|
||||||
@ -46,5 +48,4 @@ Tips:
|
|||||||
listing of all available JSON Resume themes.
|
listing of all available JSON Resume themes.
|
||||||
- Visit https://github.com/fluentdesk/fresh-themes for a complete
|
- Visit https://github.com/fluentdesk/fresh-themes for a complete
|
||||||
listing of all available FRESH themes.
|
listing of all available FRESH themes.
|
||||||
- Report bugs to https://githut.com/hacksalot/HackMyResume/issues
|
- Report bugs to https://githut.com/hacksalot/HackMyResume/issues.
|
||||||
for a quick fix, often within 24 hours.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user