Permalink
Browse files

added readme

  • Loading branch information...
1 parent d55691a commit 4e7bcc44982e3d8d7eac5f742482057d8489da22 @dnagir committed Jan 8, 2012
Showing with 22 additions and 0 deletions.
  1. +22 −0 README.md
View
@@ -0,0 +1,22 @@
+Neo4j Jars
+======================================
+
+This gem as a set of jars for Neo4j database to be use from JRuby.
+
+Usage
+======================================
+
+```ruby
+require 'neo4j-jars/core' # Core jars
+require 'neo4j-jars/backup' # Online backup jars
+require 'neo4j-jars/algo' # Algorithms jars
+require 'neo4j-jars/shell' # Shell support jars
+require 'neo4j-jars/ha' # High-Availability jars
+```
+
+TODO List
+======================================
+
+- Battlefield-test it with neo4j.rb gem
+- Extract executables from neo4j.rb
+- Better README

0 comments on commit 4e7bcc4

Please sign in to comment.