summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWu Cheng-Han2015-05-15 12:58:13 +0800
committerWu Cheng-Han2015-05-15 12:58:13 +0800
commit4e64583a0b6175d2c9a6729ffde1472dd55d389c (patch)
tree75253f2425f2e4f5906ed4fd30eca29a906ee47a /README.md
parent2d36d7ce84c636faac17cef3d3a7c22568df38fe (diff)
Marked as 0.2.8
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 16 insertions, 3 deletions
diff --git a/README.md b/README.md
index e687ed91..8accba9f 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,25 @@
-HackMD 0.2.7
+HackMD 0.2.8
===
This is a realtime collaborative markdown notes on all platforms.
But still in early stage, feel free to fork or contribute to it.
-Thanks for your using.
+Thanks for your using!
+
+There are some config you need to change in below files
+```
+./run.sh
+./config.js
+./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.
+
+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.
-License under MIT.
+**License under MIT.** \ No newline at end of file