From 872073936b57bc13a4e5d6affbe69660221e874a Mon Sep 17 00:00:00 2001 From: inmand17 <49301038+inmand17@users.noreply.github.com> Date: Thu, 27 Jul 2023 16:55:01 -0700 Subject: [PATCH] Update README.md Organized the template examples into a grid. Changed the grammar in different sections. Applied formatting updates. --- README.md | 71 ++++++++++++------------------------------------------- 1 file changed, 15 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index d6a2e7d1..78b95fb0 100644 --- a/README.md +++ b/README.md @@ -14,66 +14,34 @@

- :necktie: :briefcase: Build fast :rocket: and easy multiple beautiful resumes and create your best CV ever! + Build multiple fast and easy resumes to create your best CV ever!

Made with Vue and LESS.

-
-
- -

-

Cool
- - - -

-

Creative
- -

-

Green
- -

-

Purple
- -

-

Side Bar
- - - -

-

Left Right
- - - -

-

Material Dark
- - -

-

Oblique
- - - -

-

- -
-
+## Examples +| | | | +|:-------------------------:|:-------------------------:|:-------------------------:| +|Cool 1 |Cool 2 |Cool 3 | +|Creative |Green |Purple | +|Side Bar 1 |Side Bar 2 |Side Bar 3 | +|Left Right 1 |Left Right 2 |Left Right 3 | +|Material Dark 1 |Material Dark 2 |Oblique 1 | +|Oblique 2 |Oblique 3 | ## Prerequisite -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: +1. It is required to have Node.js with version 8.5.0 or higher installed. To see what version of Node.js is installed on your machine, type the following command into the terminal: ``` 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. +2. If you do not have Node.js installed on your machine, then go to [this link](https://nodejs.org/en/download/) in order to install Node.js. -## How to use +## How to Use 1. Clone this repository. @@ -92,25 +60,18 @@ git clone https://github.com/salomonelli/best-resume-ever.git ![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. +6. Export your resume as a 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. -
- - ## Sponsored by

@@ -118,7 +79,7 @@ Feel free to add your own templates, language supports, fix bugs or improve the Sponsored by RxDB - NodeJs Database

@@ -134,8 +95,6 @@ This project uses several open source packages: - Puppeteer - LESS -
- --- > [sarasteiert.com](https://www.sarasteiert.com)  ·