generated from haraka/haraka-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
9 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,45 +5,6 @@ | |
|
||
# haraka-plugin-resque | ||
|
||
Clone me, to create a new Haraka plugin! | ||
|
||
# Template Instructions | ||
|
||
These instructions will not self-destruct after use. Use and destroy. | ||
|
||
See also, [How to Write a Plugin](https://github.com/haraka/Haraka/wiki/Write-a-Plugin) and [Plugins.md](https://github.com/haraka/Haraka/blob/master/docs/Plugins.md) for additional plugin writing information. | ||
|
||
## Create a new repo for your plugin | ||
|
||
Haraka plugins are named like `haraka-plugin-something`. All the namespace after `haraka-plugin-` is yours for the taking. Please check the [Plugins](https://github.com/haraka/Haraka/blob/master/Plugins.md) page and a Google search to see what plugins already exist. | ||
|
||
Once you've settled on a name, create the GitHub repo. On the repo's main page, click the _Clone or download_ button and copy the URL. Then paste that URL into a local ENV variable with a command like this: | ||
|
||
```sh | ||
export MY_GITHUB_ORG=haraka | ||
export MY_PLUGIN_NAME=haraka-plugin-SOMETHING | ||
``` | ||
|
||
Clone and rename the resque repo: | ||
|
||
```sh | ||
git clone [email protected]:haraka/haraka-plugin-resque.git | ||
mv haraka-plugin-resque $MY_PLUGIN_NAME | ||
cd $MY_PLUGIN_NAME | ||
git remote rm origin | ||
git remote add origin "[email protected]:$MY_GITHUB_ORG/$MY_PLUGIN_NAME.git" | ||
``` | ||
|
||
Now you'll have a local git repo to begin authoring your plugin | ||
|
||
## rename boilerplate | ||
|
||
Replaces all uses of the word `resque` with your plugin's name. | ||
|
||
./redress.sh [something] | ||
|
||
You'll then be prompted to update package.json and then force push this repo onto the GitHub repo you've created earlier. | ||
|
||
|
||
# Add your content here | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.