Skip to content

Commit a68ad12

Browse files
authored
Update README.md
1 parent 8931e4c commit a68ad12

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
1-
# Pad
1+
# Pad
22
Pad is an extremely lightweight, low-latency, collaborative notepad built with [WebSockets](https://en.wikipedia.org/wiki/WebSocket) and [NodeJS](https://nodejs.org/)!
33

4+
[Check out our demo](https://paperpad.herokuapp.com/)
5+
6+
[![Build Status](https://travis-ci.org/petercunha/Pad.svg?branch=master)](https://travis-ci.org/petercunha/Pad)
7+
8+
Requirements
9+
------------
10+
11+
* Node 6.x
12+
* Required Node packages
13+
* Open port, if you want a public site
414

15+
As long as you have Node 6 installed, you can just `git clone` and `npm install` and you'll be ready to roll!
516

6-
## Run your own server!
17+
Run your own server!
18+
--------------------
19+
20+
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
21+
22+
Or you can install Pad youself in just a few commands
723
```bash
824
git clone https://github.com/petercunha/pad.git
925
cd pad
1026
npm install && npm start
1127
```
1228

13-
[Check out our demo](https://paperpad.herokuapp.com/)
29+

0 commit comments

Comments
 (0)