Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilmielnik authored Feb 1, 2020
1 parent d41c395 commit b28911d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# Kamil Mielnik's Curriculum Vitae
http://cv.kamilmielnik.com/

## Setup
1. `npm install`
2. `cp .env.example .env`
3. Fill in missing values in `.env`

## Scripts

### `npm run build`
Generate CSS & JS bundles in `./build/`

### `npm run createPdf`
Generate PDF version of the CV based on files in `./build/`

### `npm run deploy`
Copy files from `./build/` to a remote server (setup via variables in `.env`)

### `npm run publish`
Run `build`, `createPdf` & `deploy` scripts one by one

### `npm start`
Run development server with hot-reload

0 comments on commit b28911d

Please sign in to comment.