From 73f4339082884be29e14cf82e583e782e7e3f3be Mon Sep 17 00:00:00 2001
From: Brian Candler <B.Candler@pobox.com>
Date: Sun, 8 May 2011 11:58:02 +0100
Subject: [PATCH] Update README

---
 README | 24 ++++++++++++++++++++----
 1 file changed, 20 insertions(+), 4 deletions(-)

diff --git a/README b/README
index 447858f..53e869c 100644
--- a/README
+++ b/README
@@ -2,8 +2,24 @@ Ruby Netlink
 ============
 
 This library provides an API for using a Linux Netlink socket, for doing
-things like manipulating IP interfaces, routes and firewall rules
-programmatically.
+things things like manipulating IP interfaces and routes programmatically,
+and capturing packets from ULOG.
+
+Example
+=======
+
+    require 'linux/netlink/route'
+    ip = Linux::Netlink::Route::Socket.new
+
+    # Info about eth0 interface
+    p ip.link["eth0"]
+
+    # Addresses on eth0 interface
+    ip.addr.list(:index=>"eth0") do |addr|
+      puts addr.address
+    end
+
+See the examples/ and test/ directories for more examples.
 
 Requirements
 ============
@@ -75,8 +91,8 @@ TODO
 ====
 
 * Exception hierarchy
-* Unit tests
-* Integration tests
+* More tests
+* More netlink protocols
 
 Copyright
 =========