diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0fed978..a6a98a58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,9 @@ #### Branches -`dev` branch is the bleeding edge version of dejavu, all new changes go here. +`next` branch is the actively developer version of dejavu, a complete rewrite that's light-weight and performant and will replace the current dejavu codebase entirely. + +`dev` branch is the current version of dejavu, all bug fixes to the current version go here. `chrome-extension` branch is where we make chrome extension related changes. @@ -20,10 +22,10 @@ #### Local Installation 1. `git clone` your fork of https://github.com/appbaseio/dejavu -2. `git checkout dev` +2. `git checkout next` 3. `git submodule init && git submodule sync && git submodule update --recursive --remote` 4. `yarn` -5. `yarn start` (open dejavu in the browser on http://localhost:1358/live) +5. `yarn start` (open dejavu in the browser on http://localhost:1358/) #### Generating an AppName and URL @@ -36,7 +38,7 @@ #### Local Build -#### `dev` branch: Webpage +#### `next` branch: Webpage ```sh $ yarn start