diff --git a/README.md b/README.md index a28647c..1fac73c 100644 --- a/README.md +++ b/README.md @@ -39,15 +39,18 @@ ## Prerequisite -1. It is required to have NodeJs with version 8.5 or higher +1. It is required to have Node.js with version 8.5.0 or higher. To see what version of Node.js is installed on your machine type the following command in the terminal: -2. If you do not have installed node.js in your machine then go to [this link](https://nodejs.org/en/download/) in order to install node. +``` +node -v +``` + +2. If you do not have installed Node.js in your machine then go to [this link](https://nodejs.org/en/download/) in order to install node. ## How to use -best-resume-ever requires at least node v.8.5.0. - 1. Clone this repository. + ``` git clone https://github.com/salomonelli/best-resume-ever.git ``` @@ -56,50 +59,47 @@ git clone https://github.com/salomonelli/best-resume-ever.git 3. Run `npm install`. -4. Customize your resume in the `resume/` directory: edit your data `data.yml` and replace your profile-picture `id.jpg`. +4. Customize your resume in the `resume/` directory: edit your data `data.yml` and replace the default profile-picture `id.jpg` with your picture. Rename your picture as `id.jpg` and copy it in the `resume/` directory. -5. Preview resumes with `npm run dev`. +5. Preview resumes with `npm run dev`. The command will start a server instance and listen on port 8080. Open (http://localhost:8080/) in your browser. The page will show some resume previews. To see the preview of your resume, with your picture and data, click on one layout that you like and the resume will be opened in the same window. -6. Export with `npm run export`. +![Resume previews](/readme-images/resumePreviews.png) +6. Export your resume as pdf by running the command `npm run export`. In order to avoid errors due to the concurrency of two `npm run` commands, stop the execution of the previus `npm run dev` and then type the export command. + All resumes will be exported to the `pdf/` folder.
- ## Creating and Updating Templates Please read the developer docs on how to create or update templates.
- ## Contribute Feel free to add your own templates, language supports, fix bugs or improve the docs. Any kind of help is appreciated! If you make any kind of changes to an existing template, please commit them as new templates.
- ## Credits This project uses several open source packages: -* Vue -* Puppeteer -* LESS +- Vue +- Puppeteer +- LESS
- --- > [sarasteiert.com](https://www.sarasteiert.com)  ·  > GitHub [@salomonelli](https://github.com/salomonelli)  ·  > Twitter [@salomonelli](https://twitter.com/salomonelli) - ## License [MIT](https://github.com/salomonelli/best-resume-ever/blob/master/LICENCE.md) diff --git a/readme-images/resumePreviews.png b/readme-images/resumePreviews.png new file mode 100644 index 0000000..b5dd437 Binary files /dev/null and b/readme-images/resumePreviews.png differ