Skip to content
Browse files

Update README.md

  • Loading branch information...
1 parent b6bbf0c commit 338e5c4f470f9158e184682bd9376917f1f3ca20 @mnaamani committed Dec 6, 2012
Showing with 12 additions and 18 deletions.
  1. +12 −18 README.md
View
30 README.md
@@ -1,4 +1,4 @@
-# OTR3 - Off-the-Record Messaging [protocol v2][native bindings]
+## OTR3 - Off-the-Record Messaging [native-bindings]
This module exposes a simple evented API which wraps the native libotr installed.
Supports only versions v3.2.x of library.
@@ -7,33 +7,27 @@ Only tested on Ubuntu. (If you can help to make it build on windows please do).
Still a work in progress..
-## Building the module
-
-Required tools:
+### Install pre-requisits:
$ apt-get install nodejs nodejs-dev libotr2 libotr2-dev
-
-node-gyp:
-
$ npm install -g node-gyp
+
+### Getting the Module through git:
-install the module with npm:
-
- npm -g install
-
-Run a quick test
-
- node examples/test.js
+ git clone https://github.com/mnaamani/node-otr-v2.git
+ cd node-otr-v2/
+ npm -g install
+### Getting the module directly from npm registry:
-You can also install the module directly from npm registry:
+ npm -g install otr3
- npm -g install otr3
+[API Documentation](https://github.com/mnaamani/node-otr-v2/blob/master/doc/API.md)
-## License
+### License
GPLv2
-## Links
+### Links
The Excellent OTR Messaging software:
http://www.cypherpunks.ca/otr/

0 comments on commit 338e5c4

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