diff --git a/README.md b/README.md index a7a961b..95b47a0 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,43 @@ Well, to be honest, our inspiration comes from evernote, and we use evenote to m * We want to public our knowledge, so we have our blog(such as wordpress) and evernote, but why can't be one! * ...... -## How to use it \ No newline at end of file +## How to use it +leanote build with golang(revel) and mongodb. so you must install mongodb at first. + +1. Install mongodb, http://www.mongodb.org + +2. Configure conf/app.conf + + +``mongodb`` **required** + +the mongodb info + +```shell +db.host=localhost +db.port=27017 +db.dbname=leanote # required +db.username=root +db.password=root123 +# or you can set the mongodb url for more complex needs +# mongodb://myuser:mypass@localhost:40001,otherhost:40001/mydb +db.url=mongodb://root:root123@localhost:27017/leanote +``` +``email`` + +for find password + +``http.port`` + +default is 80 + +``adminUsername`` + +default is admin. The index site is the adminUsername's blog + +for more infomation please see app/app.conf and revel manuals http://revel.github.io/ + +3. Run leanote + +## License +leanote is released as open-source software under the GNU General Public License (GPL), version 2 or later. \ No newline at end of file