Permalink
Browse files

add readme

  • Loading branch information...
mojombo committed May 19, 2009
1 parent c600364 commit 3ce4b76fb418974b5674c7408ccd76d642c206cd
Showing with 37 additions and 8 deletions.
  1. +1 −1 .document
  2. +36 −0 README.md
  3. +0 −7 README.rdoc
View
@@ -1,4 +1,4 @@
-README.rdoc
+README.md
lib/**/*.rb
bin/*
features/**/*.feature
View
@@ -0,0 +1,36 @@
+BERTRPC
+=======
+
+By Tom Preston-Werner (tom@mojombo.com)
+
+WARNING: This software is alpha and should not be used in production without
+extensive testing. You should not consider this project production ready until
+it is released as 1.0.
+
+
+Description
+-----------
+
+BERTRPC is a Ruby BERT-RPC client library.
+
+
+Installation
+------------
+
+ gem install mojombo-bertrpc -s http://gems.github.com
+
+
+Example
+-------
+
+ require 'bertrpc'
+
+ svc = BERTRPC::Service.new('localhost', 9999)
+ svc.calc.add.call([1, 2])
+ # => 3
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.
View
@@ -1,7 +0,0 @@
-= bertrpc
-
-Description goes here.
-
-== Copyright
-
-Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.

0 comments on commit 3ce4b76

Please sign in to comment.