Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-12-27 02:23:28 +08:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Ben Gotow 2015-10-05 01:47:38 -07:00
parent 658a267f9d
commit a24508418a
1 changed files with 6 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,22 +1,16 @@
![N1 Logo](https://edgehill.s3.amazonaws.com/static/N1.png)
**An extensible, open-source mail client built on the modern web.**
![N1 Screenshot](http://nylas.github.io/N1/images/1-1-initial-outlook-base.png)
N1 is a foundation to build new email experiences. It's built on
[Electron](https://github.com/atom/electron), [React](https://facebook.github.io/react/), and [Flux](https://facebook.github.io/flux/).
**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 runs against the [Nylas Sync Engine](https://www.nylas.com/sync_engine), which is also [open source](https://nylas.github.io/N1).
We are currently in an invite-only beta. Sign up [here](https://invite.nylas.com)
to get early access. Star this repository to get even earlier access.
# Download N1
# Getting Started Building Extensions
You can download compiled versions of N1 for Mac OS X and Linux from [https://nylas.github.io/N1](https://nylas.github.io/N1). You can also build and run N1 on Windows. A Windows distribution is coming soon!
Everything in N1 is an extension. Building your own is easy.
# Build A Plugin
1. Sign up [here](https://invite.nylas.com) to request an early invitation code
1. [Download N1](https://invite.nylas.com/download) and use your early
invitation code to log in
1. Follow the [getting started guides](http://nylas.github.io/N1/docs/) to
write your first extension in 5 minutes
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.github.io/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)