diff --git a/README.md b/README.md index 20c502d..7081727 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com:haraka/haraka-plugin-resque.git -mv haraka-plugin-resque $MY_PLUGIN_NAME -cd $MY_PLUGIN_NAME -git remote rm origin -git remote add origin "git@github.com:$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 diff --git a/package.json b/package.json index d43ff06..11da94e 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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 ", + "author": "Welcome Member ", "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": "*", diff --git a/redress.sh b/redress.sh deleted file mode 100755 index 88660e5..0000000 --- a/redress.sh +++ /dev/null @@ -1,44 +0,0 @@ -#!/bin/sh - -if [ -z "$1" ]; then - echo "$0 something" - exit -fi - -sed -i '' \ - -e "s/template/${1}/g" \ - README.md - -sed -i '' \ - -e "s/template/${1}/g" \ - -e "s/template\.ini/$1.ini/" \ - test/index.js - -sed -i '' \ - -e "s/template/${1}/g" \ - package.json - -sed -i '' \ - -e "s/_template/_${1}/g" \ - -e "s/template\.ini/$1.ini/" \ - index.js - -tee Changes.md <