Skip to content
Browse files

Update README

  • Loading branch information...
1 parent 5ec76f7 commit 12c7d685fd8b22fedc503a9c252b5ea9f812a25b @gf3 committed Jan 20, 2013
Showing with 28 additions and 11 deletions.
  1. +28 −11 README.md
View
39 README.md
@@ -1,28 +1,47 @@
-# IRC-js
+IRC-js
+=====
-An IRC library for node.js
+The best IRC library for node.js
-[View Documentation](http://gf3.github.com/IRC-js/).
-## Installation
+Installation
+------------
-```sh
+Via command-line:
+
+``` sh
npm install irc-js
```
-## Tests
+Via `package.json`:
+
+``` json
+{ "dependencies":
+ { "irc-js": "2" }
+}
+```
+
+
+Tests
+-----
-```sh
+``` sh
make test
```
-# 2.0 Beta Notes
+
+2.0 Notes
+========
We recently released the first beta of IRC-js 2.0.
This release brings many changes, and documentation is not quite ready.
+
+IRC-js 2.0 uses a couple of new ECMAScript features, so currently you must use
+the `--harmony` flag when running it.
+
So, for the adventurous, here's how to get started with 2.0:
-```js
+``` javascript
/* IRC-js 2.0 provides a set of objects representing IRC entities, such as:
* Client An IRC client, create one of these first.
* Message A client sends and receives instances of this object.
@@ -86,7 +105,5 @@ irc.connect({ nick: "bot500" }, function(bot) {
*/
});
});
-
```
-IRC-js 2.0 uses a couple of new ECMAScript features, so currently you must use the `--harmony` flag when running it.

0 comments on commit 12c7d68

Please sign in to comment.
Something went wrong with that request. Please try again.