diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d620ef1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,42 @@ +# Logs +!logs +logs/*.log +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +node_modules + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history + +# VS Code +.vscode + +config.json +certs +*.crt +*.key diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..d620ef1 --- /dev/null +++ b/.npmignore @@ -0,0 +1,42 @@ +# Logs +!logs +logs/*.log +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +node_modules + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history + +# VS Code +.vscode + +config.json +certs +*.crt +*.key diff --git a/README.md b/README.md new file mode 100644 index 0000000..dc2c668 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +This documentation is placeholder documentation. Real docs coming soon. + +# Installation + +This plugin is included by default on new installations of AKP48Squared. No further installation is needed. + +# Usage + +Here's where we'll talk about how to use the plugin. More detail is available in the commands section below. + +# Commands + +`commandName`: A brief description of the command. +Usage: `commandName [optionalParam]` +Example: `commandName required optional` +Required Permissions: `['AKP48.owner', 'AKP48.op']` + +# Config + +If any configuration is needed, this is where we can talk about that. + +# Issues + +If you come across any issues, you can report them on this GitHub repo [here](https://github.com/AKP48Squared/basic-commands/issues). diff --git a/main.js b/main.js index ac6b544..1cc5e60 100644 --- a/main.js +++ b/main.js @@ -1,7 +1,6 @@ 'use strict'; -const MessageHandlerPlugin = require('../../lib/MessageHandlerPlugin'); -class IRCJoinMsg extends MessageHandlerPlugin { +class IRCJoinMsg extends global.AKP48.pluginTypes.MessageHandler { constructor(AKP48, config) { super('IRCJoinMsg', AKP48); var self = this; diff --git a/package.json b/package.json index 80dec33..021aaf3 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,27 @@ { "name": "akp48-plugin-irc-join-msg", - "version": "1.0.0", + "version": "1.0.1", "description": "Sends a message to an IRC channel any time someone joins.", "main": "main.js", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"Error: no test specified\" && exit 1", + "preversion": "git checkout master && git pull && npm ls", + "publish-patch": "npm run preversion && npm version patch && git push origin master --tags && npm publish", + "publish-minor": "npm run preversion && npm version minor && git push origin master --tags && npm publish", + "publish-major": "npm run preversion && npm version major && git push origin master --tags && npm publish" }, - "author": "Austin Peterson ", - "license": "MIT" + "author": "Austin Peterson (http://akpwebdesign.com)", + "contributors": [ + "Alan H (Feildmaster) (http://feildmaster.com/)", + "Austin Peterson (http://akpwebdesign.com/)" + ], + "license": "MIT", + "repository": { + "type": "git", + "url": "git+https://github.com/AKP48Squared/irc-join-msg.git" + }, + "bugs": { + "url": "https://github.com/AKP48Squared/irc-join-msg/issues" + }, + "homepage": "https://github.com/AKP48Squared/irc-join-msg" }