= Neo4j.rb

Neo4j.rb is a graph database for JRuby.


 
It provides:
* Mapping of ruby objects to nodes in networks rather than in tables.
* Dynamic, and schema-free - no need to declare nodes/properties/relationships in advance.
* Storage of ruby object to a file system.
* Fast traversal of relationships between nodes in a huge node space.
* Transaction with rollbacks support. 
* Indexing and querying of ruby objects.
* Migration and BatchInserter support
* Can be used instead of ActiveRecord in Ruby on Rails or Merb
* Can be accessible as REST resources.

It uses two powerful and mature Java libraries:
* Neo4J (http://www.neo4j.org/) - for persistence and traversal of the graph
* Lucene (http://lucene.apache.org/java/docs/index.html) for querying and indexing.

=== Documentation
* Wiki: http://github.com/andreasronge/neo4j/wiki
* API Documentation - http://neo4j.rubyforge.org/ (of the released version)

=== Project information
* GitHub - http://github.com/andreasronge/neo4j/tree/master
* Issue Tracking - http://neo4j.lighthouseapp.com
* Twitter - http://twitter.com/ronge
* IRC -  #neo4j @ irc.freenode.net
* Source repo - git://github.com/andreasronge/neo4j.git
* Mailing list - http://groups.google.com/group/neo4jrb (neo4jrb@googlegroups.com)

=== Presentation Materials and other URLs
* Ruby Manor 2008 - Jonathan Conway: http://jaikoo.com/assets/presentations/neo4j.pdf
* Nordic Ruby 2010 (upcoming May 21-23) http://nordicruby.org/speakers#user_29
* Neo4j wiki - http://wiki.neo4j.org/content/Main_Page (check the guidelines and domain modeling gallery pages)

=== Contributing

Have you found a bug, need help or have a patch ?
Just clone neo4j.rb and send me a pull request or email me.
Do you need help - send me an email (andreas.ronge at gmail dot com).
Please also check/add issues at lighthouse, http://neo4j.lighthouseapp.com

=== License
* Neo4j.rb - MIT, see the LICENSE file http://github.com/andreasronge/neo4j/tree/master/LICENSE.
* Lucene -  Apache, see http://lucene.apache.org/java/docs/features.html
* Neo4j - Dual free software/commercial license, see http://neo4j.org/