Skip to content

Commit d22a2c5

Browse files
committedApr 26, 2018
Updated installation instructions
1 parent d7516da commit d22a2c5

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed
 

‎README.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
1-
# md2impress [![Build Status](https://travis-ci.com/louisjordan/md2impress.svg?token=tF3yA5qbRRzsfTPZf6ue&branch=master)](https://travis-ci.com/louisjordan/md2impress)
1+
# md2impress [![Build Status](https://travis-ci.org/louisjordan/md2impress.svg?branch=master)](https://travis-ci.org/louisjordan/md2impress)
22

33
:pencil: generate web presentations from markdown!
44

5+
[Web App Demo](https://louisjordan.github.io/md2impress)
6+
57
## Installation
8+
md2impress requires **Node v8.3.0+** and **npm**. Download Node + npm [here](https://nodejs.org/en/).
9+
10+
Run these commands to install the package and its dependencies
11+
12+
```bash
13+
$ cd path/to/directory
14+
$ npm install --save md2impress
15+
```
16+
17+
or clone this repo using this command `
18+
git clone git@github.com:louisjordan/md2impress.git`
19+
20+
#### Developers
21+
22+
To run the [web application](https://louisjordan.github.io/md2impress) locally, first clone the repository then navigate to the app directory. Next, install the dependencies and finally run `npm start`.
623

724
```bash
8-
$ npm install --save md2impress # via npm
9-
$ yarn add md2impress --dev # yarn works too!
10-
$ git clone git@github.com:louisjordan/md2impress.git # via github
25+
$ git clone git@github.com:louisjordan/md2impress.git
26+
$ cd app
27+
$ npm install
28+
$ npm start
1129
```
1230

1331
## Usage

0 commit comments

Comments
 (0)
Please sign in to comment.