diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a118b6513..d9b1e5e54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,7 +69,8 @@ however, the Sync Engine is open source and you can run it yourself. to point to your Sync Engine instance. 1. After you've linked accounts to the Sync Engine, populate your - `~/.nylas/config.cson` as follows: + `~/.nylas/config.cson` as follows. You can get a list of connected accounts + and their attributes from the /accounts endpoint (ex. `http://localhost:5555/accounts`): "*": nylas: diff --git a/README.md b/README.md index d165abdff..d79d529a5 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ Plugins lie at the heart of N1 and give it it's powerful features. Building your If you would like to run the N1 source and contribute, check out our [contributing guide](https://github.com/nylas/N1/blob/master/CONTRIBUTING.md) +# Running Locally +By default the N1 source points to our hosted version of the Nylas Sync Engine; however, the Sync Engine is open source and you can [run it yourself](https://github.com/nylas/N1/blob/master/CONTRIBUTING.md#running-against-open-source-sync-engine). + # Feature Requests / Package Ideas Have an idea for a package, or a feature you'd love to see in N1? Check out our