chore: add quick start instructions

2021-11-11 16:41:55 +00:00 · 2021-11-11 16:41:55 +00:00 · 7045b6628a
parent 571fc49b32
commit 7045b6628a
1 changed files with 11 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -27,6 +27,17 @@ It is also recommended to run `git submodule update` after you pull from upstrea
 -   [Revolt Testers Server](https://app.revolt.chat/invite/Testers)
 -   [Contribution Guide](https://developers.revolt.chat/contributing)

+## Quick Start
+
+Get revite up and running locally.
+
+```
+git clone --recursive https://github.com/revoltchat/revite
+cd revite
+yarn
+yarn dev
+```
+
 ## CLI Commands

 | Command             | Description                                  |