Skip to content

Commit

Permalink
first blood
Browse files Browse the repository at this point in the history
  • Loading branch information
noogen committed Jan 13, 2024
1 parent 59cc8d9 commit df7ee73
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 90 deletions.
39 changes: 0 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 9 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "haraka-plugin-resque",
"version": "1.0.5",
"description": "Haraka plugin that...CHANGE THIS",
"version": "1.0.0",
"description": "Haraka plugin that act as a queue and perform REST post to a remote url",
"main": "index.js",
"scripts": {
"lint": "npx eslint *.js test",
Expand All @@ -11,19 +11,21 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/haraka/haraka-plugin-resque.git"
"url": "git+https://github.com/niiknow/haraka-plugin-resque.git"
},
"keywords": [
"haraka",
"plugin",
"resque"
"resque",
"queue",
"rest"
],
"author": "Welcome Member <happy-haraka-hacker@example.com>",
"author": "Welcome Member <harakakaka@example.com>",
"license": "MIT",
"bugs": {
"url": "https://github.com/haraka/haraka-plugin-resque/issues"
"url": "https://github.com/niiknow/haraka-plugin-resque/issues"
},
"homepage": "https://github.com/haraka/haraka-plugin-resque#readme",
"homepage": "https://github.com/niiknow/haraka-plugin-resque#readme",
"devDependencies": {
"eslint": "^8.55.0",
"eslint-plugin-haraka": "*",
Expand Down
44 changes: 0 additions & 44 deletions redress.sh

This file was deleted.

0 comments on commit df7ee73

Please sign in to comment.