summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWu Cheng-Han2015-06-01 18:04:25 +0800
committerWu Cheng-Han2015-06-01 18:04:25 +0800
commitf7f8c901f4bc39c3ed0a2bdfe1cbaa1ee6957999 (patch)
tree1bb09442906fa8e258c670c87491c64b6de27e68 /README.md
parent4e64583a0b6175d2c9a6729ffde1472dd55d389c (diff)
Marked as 0.2.9
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 36 insertions, 9 deletions
diff --git a/README.md b/README.md
index 8accba9f..6762b28a 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,26 @@
-HackMD 0.2.8
+HackMD 0.2.9
===
-This is a realtime collaborative markdown notes on all platforms.
-But still in early stage, feel free to fork or contribute to it.
+HackMD is a realtime collaborative markdown notes on all platforms.
+Inspired by Hackpad, but more focusing on speed and flexibility.
+Still in early stage, feel free to fork or contribute to this.
-Thanks for your using!
+Thanks for your using! :smile:
+Dependency
+---
+- PostgreSQL 9.3.6 or 9.4.1
+- MongoDB 3.0.2
+
+Import db schema
+---
+The notes are store in PostgreSQL, the schema is in the `hackmd_schema.sql`
+To import the sql file in PostgreSQL, type `psql -i hackmd_schema.sql`
+
+The users, temps and sessions are store in MongoDB, which don't need schema, so just make sure you have the correct connection string.
+
+Config
+---
There are some config you need to change in below files
```
./run.sh
@@ -13,13 +28,25 @@ There are some config you need to change in below files
./public/js/common.js
```
-You can use SSL to encrypt your site by passing certificate path in the `config.js` and set `usessl=true`.
-
-And there is a script called `run.sh`, it's for someone like me to run the server via npm package `forever`, and can passing environment variable to the server, like heroku does.
+The script `run.sh`, it's for someone like me to run the server via npm package `forever`, and can passing environment variable to the server, like heroku does.
To install `forever`, just type `npm install forever -g`
-The notes are store in PostgreSQL, and I provided the schema in the `hackmd_schema.sql`.
-The users and sessions are store in mongoDB, which don't need schema, so just connect it directly.
+You can use SSL to encrypt your site by passing certificate path in the `config.js` and set `usessl=true`
+
+Run a server
+---
+To run the server, type `bash run.sh`
+Log will be at `~/.forever/hackmd.log`
+
+Stop a server
+---
+To stop the server, simply type `forever stop hackmd`
+
+Backup db
+---
+To backup the db, type `bash backup.sh`
+Backup files will be at `./backups/`
+
**License under MIT.** \ No newline at end of file