Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2025-09-06 04:35:30 +08:00
Code Issues Projects Releases Packages Wiki Activity

fix(readmes): Add "Install this plugin" bits to the plugin READMEs

Browse source
This commit is contained in:
Ben Gotow 2015-10-04 00:42:54 -07:00
parent fe06835540
commit 4813464978
7 changed files with 129 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
examples/N1-Composer-Templates/README.md Normal file
View file

@ -0,0 +1,29 @@
# Composer Templates
Create templates you can use to pre-fill the N1 composer - never type the same
email again! Templates live in the ~/.nylas/templates directory on your computer.
Each template is an HTML file - the name of the
file is the name of the template, and it's contents are the default message body.
If you include HTML <code> tags in your template, you can create
regions that you can jump between and fill easily.
Give <code> tags the `var` class to mark them as template regions. Add
the `empty` class to make them dark yellow. When you send your message, <code>
tags are always stripped so the recipient never sees any highlighting.
This example is a good starting point for plugins that want to extend the composer
experience.
<img src="https://raw.githubusercontent.com/nylas/N1/master/examples/N1-Github-Contact-Card-Section/screenshot.png">
#### Install this plugin:
1. Download and run N1
2. From the menu, select `Developer > Install a Package Manually...`
The dialog will default to this examples directory. Just choose the
package to install it!
> When you install packages, they're moved to `~/.nylas/packages`,
> and N1 runs `apm install` on the command line to fetch dependencies
> listed in the package's `package.json`

18
examples/N1-Composer-Translate/README.md
View file

@ -1,12 +1,24 @@
## Translate
A sample package for N1 that is translates draft text to other languages using the Yandex Translation API.
A package for N1 that translates draft text into other languages using the Yandex Translation API.
#### To build documentation (the manual way):
#### Install this plugin:
1. Download and run N1
2. From the menu, select `Developer > Install a Package Manually...`
The dialog will default to this examples directory. Just choose the
package to install it!
> When you install packages, they're moved to `~/.nylas/packages`,
> and N1 runs `apm install` on the command line to fetch dependencies
> listed in the package's `package.json`
#### Build documentation:
```
cjsx-transform lib/main.cjsx > docs/main.coffee
docco docs/main.coffee
rm docs/main.coffee
```
```

26
examples/N1-Filters/README.md
View file

@ -1,18 +1,30 @@
# Filters package for Edgehill
# Filters package for N1
<img src="https://raw.githubusercontent.com/nylas/edgehill-plugins/master/filters/filters-screencap.png?token=ABx0UZ4A4Qd2ikF3y6kwHOK3MX_ZEf1lks5WEr6WwA%3D%3D">
<img src="https://raw.githubusercontent.com/nylas/N1/master/examples/N1-Filters/filters-screencap.png">
## Who?
#### Install this plugin:
1. Download and run N1
2. From the menu, select `Developer > Install a Package Manually...`
The dialog will default to this examples directory. Just choose the
package to install it!
> When you install packages, they're moved to `~/.nylas/packages`,
> and N1 runs `apm install` on the command line to fetch dependencies
> listed in the package's `package.json`
#### Who?
The source is annotated for people who are familiar with React, but not familiar with APIs from either Atom or N1.
As such, we will not annotate any code that is specific for React, but we'll annotate code for everything else.
## Why?
#### Why?
There's no native way to automate mail filtering in Edgehill. This package provides a lightweight interface and implementation of mail filters and mail rules to handle repetitive mail tasks for you.
There's no native way to automate mail filtering in N1. This package provides a lightweight interface and implementation of mail filters and mail rules to handle repetitive mail tasks for you.
## How?
#### How?
This package works in two steps: managing the filters and applying the filters.
@ -33,7 +45,7 @@ The only actions this package supports currently are:
- Deleting
- Archiving (skipping the inbox)
## Roadmap?
#### Roadmap
Right now, both managing the filters and applying the filters is done client-side.

22
examples/N1-Github-Contact-Card-Section/README.md Normal file
View file

@ -0,0 +1,22 @@
# Github Contact Card Section
Extends the contact card in the sidebar to show public repos of the people you email.
Uses GitHub's public API to look up a GitHub user based on their email address,
and then displays public repos and their stars.
This example is a good starting point for plugins that want to display data from
external sources in the sidebar.
<img src="https://raw.githubusercontent.com/nylas/N1/master/examples/N1-Github-Contact-Card-Section/screenshot.png">
#### Install this plugin:
1. Download and run N1
2. From the menu, select `Developer > Install a Package Manually...`
The dialog will default to this examples directory. Just choose the
package to install it!
> When you install packages, they're moved to `~/.nylas/packages`,
> and N1 runs `apm install` on the command line to fetch dependencies
> listed in the package's `package.json`

16
examples/N1-Personal-Level-Indicators/README.md
View file

@ -1,9 +1,19 @@
# Personal Level Icon
## What?
An icon to indicate whether an email was sent to either just you, or you and other recipients, or a mailing list that you were on.
## Who?
#### Install this plugin:
1. Download and run N1
2. From the menu, select `Developer > Install a Package Manually...`
The dialog will default to this examples directory. Just choose the
package to install it!
> When you install packages, they're moved to `~/.nylas/packages`,
> and N1 runs `apm install` on the command line to fetch dependencies
> listed in the package's `package.json`
#### Who?
This package is annotated for developers who have no experience with React, Flux, Electron, or N1.

13
examples/N1-Phishing-Detection/README.md
View file

@ -1,4 +1,3 @@
## Phishing Detection
A sample package for Nylas Mail to detect simple phishing attempts. This package display a simple warning if
@ -6,6 +5,18 @@ a message's originating address is different from its return address. The warnin
![screenshot](./screenshot.png)
#### Install this plugin:
1. Download and run N1
2. From the menu, select `Developer > Install a Package Manually...`
The dialog will default to this examples directory. Just choose the
package to install it!
> When you install packages, they're moved to `~/.nylas/packages`,
> and N1 runs `apm install` on the command line to fetch dependencies
> listed in the package's `package.json`
#### Who is this for?
This package is our slimmest example package. It's annotated for developers who have no experience with React, Flux, Electron, or N1.

27
examples/N1-Send-Availability/README.md
View file

@ -1,17 +1,28 @@
# Send availability
<img src="https://raw.githubusercontent.com/nylas/edgehill-plugins/master/send-availability/screenshots/send-availability-1.png?token=ABx0UYNs7ML7429qdQM-Ewhh_4Bd05Xhks5WEw4YwA%3D%3D">
This is a package that allows you to email times that you are free to other people to make it easier to schedule appointments. The package adds an "Add Availability" button next to the "Send" button. The button opens a calendar, in which you can select time periods to email to other people.
<img src="https://raw.githubusercontent.com/nylas/edgehill-plugins/master/send-availability/screenshots/send-availability-2.png?token=ABx0UaOLaj9TsYMkt1IeL5BSJQ-L5Fwsks5WEw5BwA%3D%3D">
<img src="https://raw.githubusercontent.com/nylas/N1/master/examples/N1-Send-Availability/screenshots/send-availability-1.png">
## Who?
<img src="https://raw.githubusercontent.com/nylas/N1/master/examples/N1-Send-Availability/screenshots/send-availability-2.png">
#### Install this plugin:
1. Download and run N1
2. From the menu, select `Developer > Install a Package Manually...`
The dialog will default to this examples directory. Just choose the
package to install it!
> When you install packages, they're moved to `~/.nylas/packages`,
> and N1 runs `apm install` on the command line to fetch dependencies
> listed in the package's `package.json`
#### Who?
This package annotated for those who are familiar with React, Flux already, and have already seen other N1 packages. This package is more complicated than the other packages, as it demonstrates how arbitrary JavaScript can be inserted to create custom functionality.
## Why?
#### Why?
When making appointments with other people, you need to share your availabilities in order to schedule a time.
## What?
This is a package that allows you to email times that you are free to other people to make it easier to schedule appointments. The package adds an "Add Availability" button next to the "Send" button. The button opens a calendar, in which you can select time periods to email to other people.