depau/HackMD
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
jackycute 2015-07-02 00:15:34 +08:00
parent 10c9811fc5
commit cb54826a00
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,8 +1,8 @@
HackMD 0.3.1 HackMD 0.3.1
=== ===
HackMD is a realtime collaborative markdown notes on all platforms. HackMD is a realtime collaborative markdown notes on all platforms.
Inspired by Hackpad, but more focusing on speed and flexibility. Inspired by Hackpad, but more focusing on speed and flexibility.
Still in early stage, feel free to fork or contribute to this. Still in early stage, feel free to fork or contribute to this.
Thanks for your using! :smile: Thanks for your using! :smile:
@ -14,7 +14,7 @@ Database dependency
Import database schema Import database schema
--- ---
The notes are store in PostgreSQL, the schema is in the `hackmd_schema.sql` 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` 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. The users, temps and sessions are store in MongoDB, which don't need schema, so just make sure you have the correct connection string.
@ -48,7 +48,7 @@ There are some config you need to change in below files
**From 0.3.1, we no longer recommend using `forever` to run your server.** **From 0.3.1, we no longer recommend using `forever` to run your server.**
We using `pm2` to run server. We using `pm2` to run server.
See [here](https://github.com/Unitech/pm2) for details. See [here](https://github.com/Unitech/pm2) for details.
You can use SSL to encrypt your site by passing certificate path in the `config.js` and set `usessl=true` You can use SSL to encrypt your site by passing certificate path in the `config.js` and set `usessl=true`
@ -67,4 +67,4 @@ Backup db
--- ---
To backup the db, type `bash backup.sh` To backup the db, type `bash backup.sh`
**License under MIT.** **License under MIT.**