From 4b684929f3e1fc0b1b8b61c2609ffa57c2e1e266 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20Ku=C5=BAma?= <kuba@jah.pl>
Date: Wed, 1 Jun 2011 14:51:57 +0200
Subject: [PATCH] added simple readme

---
 README.rdoc        | 31 ++++++++++++++++++++++++++++++-
 lib/sane/device.rb |  4 ++++
 2 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.rdoc b/README.rdoc
index 46545e4..ed52043 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -1,6 +1,35 @@
 = SANE FFI
 
-Scanner Access Now Easier in Ruby using FFI. This gem provides bindings
+Scanner Access Now Easier in Ruby using FFI. This gem provides
+bindings to SANE library using Ruby FFI. You can easily access to the
+device state (i.e. buttons), setup device parameters, scan images,
+etc.
+
+== Usage
+
+  >> require "sane"
+  => true
+  >> Sane.open { |sane| puts sane.devices.inspect }
+  [#<Sane::Device:"genesys:libusb:002:032">]
+  => nil
+  >> Sane.open { |sane| puts sane.devices.first.name }
+  genesys:libusb:002:032
+  => nil
+  >> Sane.open { |sane| puts sane.devices.first.vendor }
+  Canon
+  => nil
+  >> Sane.open { |sane| puts sane.devices.first.model }
+  LiDE 100
+  => nil
+  >> Sane.open { |sane| puts sane.devices.first.type }
+  flatbed scanner
+  => nil
+  >> Sane.open { |sane| sane.devices.first.open { |device| puts device.describe(:copy) } }
+  {:name=>"copy", :title=>"Copy button", :desc=>"Copy button", :type=>:bool, :unit=>:none, :size=>4, :cap=>70}
+  => nil
+  >> Sane.open { |sane| sane.devices.first.open { |device| puts device[:copy] } }
+  false
+  => nil
 
 == Copyright
 
diff --git a/lib/sane/device.rb b/lib/sane/device.rb
index 3ded72b..8847056 100644
--- a/lib/sane/device.rb
+++ b/lib/sane/device.rb
@@ -116,6 +116,10 @@ class Sane
       option_descriptors[option_lookup(option)]
     end
 
+    def inspect
+      %Q{#<#{self.class.name}:"#{name}">}
+    end
+
     private
 
     def ensure_closed!