Skip to content
This repository has been archived by the owner on Nov 11, 2020. It is now read-only.

Commit

Permalink
Update to new AKP48 pluginType API; update docs/package.json.
Browse files Browse the repository at this point in the history
  • Loading branch information
AKPWebDesign committed May 12, 2016
1 parent 3a6f9b7 commit 26c5153
Show file tree
Hide file tree
Showing 5 changed files with 129 additions and 6 deletions.
42 changes: 42 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
42 changes: 42 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -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
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <requiredParam> [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).
3 changes: 1 addition & 2 deletions main.js
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
24 changes: 20 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>",
"license": "MIT"
"author": "Austin Peterson <[email protected]> (http://akpwebdesign.com)",
"contributors": [
"Alan H (Feildmaster) <[email protected]> (http://feildmaster.com/)",
"Austin Peterson <[email protected]> (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"
}

0 comments on commit 26c5153

Please sign in to comment.