Skip to content
Browse files

add more introduction to README

  • Loading branch information...
1 parent f8e1539 commit 968c485b18c50974b036478aeaadbc497c6817ce @avalanche123 committed Apr 11, 2012
Showing with 16 additions and 3 deletions.
  1. +16 −3 README.md
View
19 README.md
@@ -1,5 +1,11 @@
# uv.rb - libuv FFI bindings for Ruby
+Libuv is a cross platform asynchronous IO implementation that powers NodeJS. It supports sockets, both UDP and TCP, filesystem operations, TTY, Pipes and other asynchronous primitives like timer, check, prepare and idle.
+
+UV.rb is FFI Ruby bindings for libuv.
+
+## Usage
+
Create a uv loop or use a default one
```ruby
@@ -18,12 +24,22 @@ end
loop.run
```
+Find more examples in examples directory
+
## Installation
```shell
gem install uvrb
```
+or
+
+```shell
+git clone ...
+cd ...
+bundle install
+```
+
Make sure you have libuv compiled and a .dylib file available in your
lib path.
@@ -34,9 +50,6 @@ by running:
brew install Formula/libuv.rb --HEAD --with-dylib
```
-## How to
-
-find examples in examples directory
## What's supported

0 comments on commit 968c485

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