Skip to content

Commit

Permalink
readme: Update badge links + NPM scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
tohjustin committed Jul 12, 2017
1 parent b25ad61 commit 5a79332
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</p>
<p align="center">
<a href="https://circleci.com/gh/tohjustin/pomodori/tree/master"><img src="https://circleci.com/gh/tohjustin/pomodori/tree/master.svg?style=shield" alt="CircleCI Build Status"/></a>
<a href="https://github.com/tohjustin/pomodori/releases/tag/v2.1.0"><img src="https://img.shields.io/github/release/tohjustin/pomodori.svg" alt="Release Version"/></a>
<a href="https://github.com/tohjustin/pomodori/releases"><img src="https://img.shields.io/github/release/tohjustin/pomodori.svg" alt="Release Version"/></a>
<a href="https://codecov.io/gh/tohjustin/pomodori"><img src="https://codecov.io/gh/tohjustin/pomodori/branch/master/graph/badge.svg" alt="Codecov" /></a>
<a href="https://www.codacy.com/app/tohjustin/pomodori?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tohjustin/pomodori&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/ab08c87aa6a3467496591b87ad77f8e8"/></a>
<a href="https://pomodori-pwa.firebaseapp.com/lighthouseReport.html"><img src="https://img.shields.io/badge/lighthouse-100%2F100-ff69b4.svg"/></a>
Expand All @@ -24,10 +24,9 @@
## Prerequisites

- [Node.js](https://nodejs.org/en/download/)
- [npm](https://docs.npmjs.com/getting-started/installing-node)
- [Yarn](https://yarnpkg.com/en/docs/install#mac-tab) (optional, alternative to npm)
- [NPM](https://docs.npmjs.com/getting-started/installing-node) + [Yarn](https://yarnpkg.com/en/docs/install#mac-tab)

(Optional) If you want to test the build files locally (via `npm run serve`):
**(Optional)** If you want to test the build files locally (via `yarn run serve`):
- [Python](https://www.python.org/)
- [Flask](http://flask.pocoo.org/)

Expand All @@ -36,26 +35,29 @@
``` bash
git clone https://github.com/tohjustin/pomodori.git
cd ./pomodori
npm install # you can use "yarn" instead
yarn
```

## Getting Started

``` bash
# serve with hot reload at localhost:8080
npm run dev
yarn run dev

# build for production with minification
npm run build

# run eslint
npm run lint
yarn run build

# build for production with minification + serve build at localhost:5000 (Flask server)
npm run serve
yarn run serve

# run eslint
yarn run lint

# run unit tests
npm test
yarn run unit

# run eslint + unit tests
yarn test
```

This project's build setup is scaffolded by the [vue-cli](https://github.com/vuejs/vue-cli) project. For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for pwa-template](https://github.com/vuejs-templates/pwa).
Expand Down

0 comments on commit 5a79332

Please sign in to comment.