diff --git a/README.md b/README.md
index 2db9995..12c4faf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,98 @@
-# casvisor
\ No newline at end of file
+
📦⚡️ Casvisor
+An open-source logging and auditing system developed by Go and React.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Online Demo
+Deployed site: [https://log.casbin.com/](https://log.casbin.com/)
+
+## Architecture
+Casvisor contains 2 parts:
+Name | Description | Language | Source code
+----|------|----|----
+Frontend | Web frontend UI for Casvisor | Javascript + React | https://github.com/casbin/casvisor/tree/master/web
+Backend | RESTful API backend for Casvisor | Golang + Beego + MySQL | https://github.com/casbin/casvisor
+
+## Installation
+Casvisor uses Casdoor to manage members. So you need to create an organization and an application for Casvisor in a Casdoor instance.
+
+### Necessary configuration
+
+#### Get the code
+```bash
+go get github.com/casbin/casdoor
+go get github.com/casbin/casvisor
+```
+
+or
+
+```bash
+git clone https://github.com/casbin/casdoor
+git clone https://github.com/casbin/casvisor
+```
+
+#### Setup database
+
+Casvisor will store its users, nodes and topics informations in a MySQL database named: `casvisor`, will create it if not existed. The DB connection string can be specified at: https://github.com/casbin/casvisor/blob/master/conf/app.conf
+
+```ini
+dataSourceName = root:123@tcp(localhost:3306)/
+```
+Casvisor uses XORM to connect to DB, so all DBs supported by XORM can also be used.
+
+#### Configure Casdoor
+
+After creating an organization and an application for Casvisor in a Casdoor, you need to update `clientID`, `clientSecret`, `casdoorOrganization` and `casdoorApplication` in app.conf.
+
+#### Run Casvisor
+
+- Configure and run Casvisor by yourself. If you want to learn more about casvisor.
+- Open browser: http://localhost:16001/
+
+### Optional configuration
+
+#### Setup your Casvisor to enable some third-party login platform
+
+ Casvisor uses Casdoor to manage members. If you want to log in with oauth, you should see [casdoor oauth configuration](https://casdoor.org/docs/provider/OAuth).
+
+#### OSS, Mail, and SMS services
+
+ Casvisor uses Casdoor to upload files to cloud storage, send Emails and send SMSs. See Casdoor for more details.
+
+## Contribute
+
+For Casvisor, if you have any questions, you can give Issues, or you can also directly start Pull Requests(but we recommend giving issues first to communicate with the community).
+
+## License
+
+[Apache-2.0](https://github.com/casvisor/casvisor/blob/master/LICENSE)
\ No newline at end of file