From f243e1112d40efdf523e3ef4f370ea09b21a3291 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Tue, 11 Aug 2015 17:07:31 +0100 Subject: [PATCH] minor small fixes --- .gitignore | 31 ++++++++++++++++++++++++++++++- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- index.js | 4 +++- 3 files changed, 76 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index c2658d7d1..aacde9626 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,30 @@ -node_modules/ +# Created by https://www.gitignore.io + +### Node ### +# Logs +logs +*.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 +# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git +node_modules diff --git a/README.md b/README.md index 9aa098067..98e3169aa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,44 @@ # discord.js -A JS interface for the Discord API. +Discord.js is a node module that allows you to interface with the [Discord](https://discordapp.com/) API for creation of things such as bots or loggers. + +### Installation +``npm install discord.js`` + +### Example usage +```js +var Discord = require("discord.js"); + +var myBot = new Discord.Client(); + +myBot.login("discord email", "discord password", function(e) { + + if(e){ + console.log("Couldn't log in"); + return; + } + + myBot.on("disconnected", function() { + console.log("Disconnected!"); + process.exit(0); + }); + + myBot.on("ready", function(e) { + console.log("Ready to go!"); + }); + + myBot.on("message", function(message) { + + if(message.content === "Ping!"){ + + myBot.sendMessage(message.channel, "Pong!"); + + } + + } + +} + +``` +### TODO +* Documentation +* Being able to cache new servers and channels as well as ones that are deleted - this is currently only done when a bot is created diff --git a/index.js b/index.js index 7c1c1fc0a..8025f04f3 100644 --- a/index.js +++ b/index.js @@ -275,7 +275,7 @@ exports.Client.prototype.channelFromId = function(id){ exports.Client.prototype.getChannelLogs = function(channel, amount, cb){ - amount = amount || 0; + amount = amount+1 || 0; var client = this; request @@ -289,6 +289,8 @@ exports.Client.prototype.getChannelLogs = function(channel, amount, cb){ datList.add( new Message(item, channel) ); } + datList.removeIndex(0); + cb(datList); });