diff --git a/README.md b/README.md new file mode 100644 index 000000000..4c9c5ce18 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ + +# 🌀 Zen Browser + +Experience tranquillity while browsing the web without people tracking you! + + +## 🚀 Run Locally + +Clone the project + +```bash +git clone https://github.com/zen-browser/desktop.git +cd desktop +``` + +Install gluon + +```bash +npm i -g gluon@next +``` + +Download and bootstrap the browser + +``` +gluon download && gluon bootstrap +``` + +Initialize the browser and start building it + +``` +npm run init && npm run build +``` + +Finally, run the browser! + +``` +npm start +``` + +## Contributing + +Contributions are always welcome! + +See `contributing.md` for ways to get started. + +Please adhere to this project's `code of conduct`. + + +## License + +[MPL LICENSE](https://choosealicense.com/licenses/mit/) +