robotirc

Multifonction IRC bot written in Node.js
Log | Files | Refs | README | LICENSE

commit 7fef6976de5583f51530dae7c061a5b6936fef82
parent 98249a292036cc731a78bcdf36764a85e524696d
Author: Frederic Cambus <fcambus@users.sourceforge.net>
Date:   Fri,  3 Jan 2014 01:16:36 +0100

Documentation update

Diffstat:
MREADME.md | 79++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 78 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md @@ -2,7 +2,84 @@ ## Description -Multifonction IRC bot written in Node. +Multifonction IRC bot written in Node.js. + +## Configuration + +Configuration options are set in the `config.json` file : + + { + "server": "irc.freenode.net", + "nickname": "robotirc", + "options": { + "userName": "robotirc", + "realName": "RobotIRC 0.1.0", + "port": 6667, + "autoRejoin": true, + "autoConnect": true, + "channels": [ + "#robotirc" + ] + } + } + +## Commands + +RobotIRC supports the following commands : + +- !alexa (Get Alexa traffic rank for a domain or URL) +- !date (Display server local time) +- !expand (Expand a shortened URL) +- !geoip (IP address Geolocation) +- !headers (Display HTTP headers for queried URL) +- !resolve (Get A records (IPv4) and AAAA records (IPv6) for queried domain) +- !reverse (Get reverse (PTR) records from IPv4 or IPv6 addresses) +- !wikipedia (Query Wikipedia for an article summary) + +## Examples + + <fcambus> !alexa echojs.com + <robotirc> Alexa Traffic Rank for echojs.com : 267098 + + <fcambus> !date + <robotirc> Fri Jan 03 2014 01:02:39 GMT+0100 (CET) + + <fcambus> !expand http://bit.ly/1g4jD0H + <robotirc> http://www.echojs.com/ + + <fcambus_> !geoip 77.88.8.8 + <robotirc> country: Russian Federation + <robotirc> dma_code: 0 + <robotirc> area_code: 0 + <robotirc> ip: 77.88.8.8 + <robotirc> asn: AS13238 + <robotirc> continent_code: EU + <robotirc> isp: Yandex LLC + <robotirc> longitude: 100 + <robotirc> latitude: 60 + <robotirc> country_code: RU + <robotirc> country_code3: RUS + + <fcambus> !headers http://www.echojs.com + <robotirc> server: nginx + <robotirc> date: Fri, 03 Jan 2014 00:08:05 GMT + <robotirc> content-type: text/html;charset=utf-8 + <robotirc> content-length: 16769 + <robotirc> connection: keep-alive + <robotirc> vary: Accept-Encoding + <robotirc> status: 200 OK + <robotirc> x-xss-protection: 1; mode=block + <robotirc> x-frame-options: sameorigin + + <fcambus> !resolve echojs.com + <robotirc> 46.19.37.108 + <robotirc> 2a02:2770::21a:4aff:feb3:2ee + + <fcambus> !reverse 77.88.8.8 + <robotirc> dns.yandex.ru + + <fcambus> !reverse 2a02:6b8::feed:ff + <robotirc> dns.yandex.ru ## License