mirror of
https://github.com/Foundry376/Mailspring.git
synced 2024-11-11 18:32:20 +08:00
143f301baf
No more warning message about needing Node v0.10. This got fixed :D Adding more info about our commit guidelines.
28 lines
1.9 KiB
Markdown
28 lines
1.9 KiB
Markdown
|
|
|
|
|
|
|
|
**N1 is an open-source mail client built on the modern web with [Electron](https://github.com/atom/electron), [React](https://facebook.github.io/react/), and [Flux](https://facebook.github.io/flux/).** It is designed to be extensible, so it's easy to create new experiences and workflows around email. N1 is built on the Nylas Sync Engine which is also [open source free software](https://github.com/nylas/sync-engine).
|
|
|
|
[](https://travis-ci.org/nylas/N1)
|
|
[](http://slack-invite.nylas.com)
|
|
|
|
# Download N1
|
|
|
|
You can download compiled versions of N1 for Mac OS X and Linux from [https://nylas.com/N1](https://nylas.com/N1). You can also build and run N1 on Windows. A Windows distribution is coming soon!
|
|
|
|
# Build A Plugin
|
|
|
|
Plugins lie at the heart of N1 and give it it's powerful features. Building your own plugins allows you to integrate the app with other tools, experiment with new workflows, and more. Follow the [Getting Started guide](http://nylas.com/N1/getting-started/) to write your first plugin in 5 minutes.
|
|
|
|
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
|
|
[public Trello board](https://trello.com/b/hxsqB6vx/n1-open-source-roadmap)
|
|
to contribute your thoughts and vote on existing ideas.
|