diff --git a/README.md b/README.md index 92f301b3f..361c7e266 100644 --- a/README.md +++ b/README.md @@ -1,14 +1 @@ Nylas Mail is a hackable platform for your personal data, built on [Electron](https://github.com/atom/electron) and the [Nylas Platform APIs](https://nylas.com/sync_engine). - - - -## Building Nylas Mail - -* [Linux](docs/build-instructions/linux.md) -* [OS X](docs/build-instructions/os-x.md) -* [FreeBSD](docs/build-instructions/freebsd.md) -* [Windows](docs/build-instructions/windows.md) - -## Extending Nylas Mail - -It's easy to extend Nylas Mail using your favorite web technologies. Check out the [Nylas Package API](docs/index) to get started, and the [API reference](https://atom.io/docs/api) for information about specific classes. \ No newline at end of file diff --git a/examples/README.md b/examples/README.md index 545b6c9dc..70d8a4733 100644 --- a/examples/README.md +++ b/examples/README.md @@ -5,9 +5,9 @@ packages in N1. ## Getting Started -1. Each package is in its own folder. Simply copy the folder you want to - try out to `$HOME/.nylas/packages` and restart N1. -1. The entry point of each package is the `activate` method of +1. Each package is in its own folder. To try out a package, copy the folder + into `$HOME/.nylas/packages`, run `apm install`, and restart N1. +2. The entry point of each package is the `activate` method of `lib/main.cjsx`. Most packages do nothing but register themselves with the `ComponentRegistry` -1. Read the annotated source code of the package files. +3. Read the annotated source code of the package files.