diff --git a/README.md b/README.md index 5996ad4..69e04aa 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,13 @@ NoteHub's implementation aims for ultimate simplicity and performance. 2. The rendering of note pages: there are HTML file tempates with placeholders, which will be trivially filled with replacements. 3. The LRU cache holds the rendered HTML for the most popular notes, which makes their access a static O(1) operation without any DB I/O. 4. The server keeps corresponding models for all notes in the cache for statistics updates. These models are persisted every 5 minutes to the DB. + +## Installation & Deployment + +To run NoteHub as a standalone version, execute: + +1. `git clone https://github.com/chmllr/NoteHub.git` +2. `npm install` +3. `npm start` + +This starts a NoteHub instance on port 3000. \ No newline at end of file diff --git a/package.json b/package.json index d3b6d1b..a6e12fa 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "Free Pastebin for One-Off Markdown Publishing", "main": "server.js", "scripts": { - "server": "node server.js", + "start": "node server.js", "devser": "nodemon server.js", "test": "echo \"Error: no test specified\" && exit 1" },