From 3dd68363b73f3e5ac698b5c4279634f3194248ed Mon Sep 17 00:00:00 2001 From: Ben Gotow Date: Thu, 30 Apr 2015 16:24:09 -0700 Subject: [PATCH] fix(readme): Rip out Atom readme, replace with our own minimal one --- README.md | 65 ++++--------------------------------------------------- 1 file changed, 4 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 4fd06f851..92f301b3f 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,14 @@ -![Atom](https://cloud.githubusercontent.com/assets/72919/2874231/3af1db48-d3dd-11e3-98dc-6066f8bc766f.png) +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). -Atom is a hackable text editor for the 21st century, built on [atom-shell](https://github.com/atom/atom-shell), and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration. -Visit [atom.io](https://atom.io) to learn more or visit the [Atom forum](https://discuss.atom.io). -Visit [issue #3684](https://github.com/atom/atom/issues/3684) to learn more -about the Atom 1.0 roadmap. - -## Installing - -### OS X - -Download the latest [Atom release](https://github.com/atom/atom/releases/latest). - -Atom will automatically update when a new release is available. - -### Windows - -Download the latest [AtomSetup.exe installer](https://github.com/atom/atom/releases/latest). - -Atom will automatically update when a new release is available. - -You can also download an `atom-windows.zip` file from the [releases page](https://github.com/atom/atom/releases/latest). -The `.zip` version will not automatically update. - -#### Uninstalling Chocolatey Version - -The recommended installation of Atom on Windows used to be using [Chocolatey](https://chocolatey.org/packages/Atom/). -This is no longer recommended now that the Atom Windows installer & auto-updater -exists. - -To switch from Chocolatey to the new installer: - * Upgrade to Atom 0.155 or above by running `cup Atom` - * Run `cuninst Atom` to uninstall the Chocolatey version of Atom - * This will not delete any of your installed packages or Atom config files. - * Download the latest [AtomSetup.exe installer](https://github.com/atom/atom/releases/latest). - * Double-click the downloaded file to install Atom - -### Debian Linux (Ubuntu) - -Currently only a 64-bit version is available. - -1. Download `atom-amd64.deb` from the [Atom releases page](https://github.com/atom/atom/releases/latest). -2. Run `sudo dpkg --install atom-amd64.deb` on the downloaded package. -3. Launch Atom using the installed `atom` command. - -The Linux version does not currently automatically update so you will need to -repeat these steps to upgrade to future releases. - -### Red Hat Linux (Fedora, CentOS, Red Hat) - -Currently only a 64-bit version is available. - -1. Download `atom.x86_64.rpm` from the [Atom releases page](https://github.com/atom/atom/releases/latest). -2. Run `sudo yum localinstall atom.x86_64.rpm` on the downloaded package. -3. Launch Atom using the installed `atom` command. - -The Linux version does not currently automatically update so you will need to -repeat these steps to upgrade to future releases. - -## Building +## 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) -## Developing +## Extending Nylas Mail -Check out the [guides](https://atom.io/docs/latest) and the [API reference](https://atom.io/docs/api). +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