@sockethub/irc2as 4.0.0-alpha.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Nick Jennings
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# IRC2AS
+
+Parses the IRC protocol into ActivtyStreams objects.
+
+## Overview
+
+Currently a very simple library to parse incoming IRC protocol messages and generate activity
+streams. The activity streams are not fully AS2.0 compliant, but aim to be shaped in the spirit
+of them, and as time goes on hopefully become more compliant (PRs & feedback welcome).
+
+## Usage
+
+```javascript
+    var IRC2AS = require('irc2as');
+    var irc2as = new IRC2AS({server: 'irc.freenode.net'});
+
+    irc2as.events.on('incoming', function (asObject) {
+      console.log('activity stream: ', asObject);
+    });
+
+    irc2as.events.on('error', function (asObject) {
+      console.log('error response to something we sent: ', asObject);
+    });
+
+    irc2as.events.on('unprocessed', function (line) {
+      console.log(`irc line we don't know what to do with (yet), PRs welcome`, line);
+    });
+
+    irc2as.events.on('pong', function (timestamp) {
+      console.log('confirmation of something we sent: ', timestamp);
+    });
+
+    irc2as.events.on('ping', function (timestamp) {
+      console.log('sending ping to server at ', timestamp);
+    });
+
+    // ....  some code to get IRC socket messages
+    ircClient.on('data', this.irc2as.input.bind(this.irc2as));
+```
+
+## License
+
+MIT
+
+## Maintainer
+
+Nick Jennings <nick@silverbucket.net>
+