Navigation Menu

Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
grob committed Mar 20, 2015
1 parent 66087a9 commit 3a0523c
Showing 1 changed file with 14 additions and 21 deletions.
35 changes: 14 additions & 21 deletions README.md
@@ -1,36 +1,29 @@
About Ringo SQLstore
===============
# About Ringo SQLstore

Ringo SQLstore is a lightweight ORM/storage implementation for [RingoJS]. It uses JDBC for communication with databases. Current features are:
Ringo SQLstore is a lightweight ORM/storage implementation for [RingoJS](http://ringojs.org/). It uses JDBC for communication with databases. Current features are:

* Creation of tables and sequences
* Transaction support
* Lazy loading
* One-to-one, one-to-many and many-to-many mappings
* Connection pooling
* Entity cache
* Object caching
* Easy SQL-like querying

Supported databases are H2, MySQL (5.x), Oracle (XE) and PostgreSQL (8.x). H2 is part of the package, so one can start right off using it without the hassle of installing and configuring a database.
Currently supported databases are [H2](http://h2database.com), [MySQL (5.x)](http://mysql.com), [Oracle (XE)](http://www.oracle.com/technetwork/products/express-edition/overview/index.html) and [PostgreSQL (8.x)](http://postgresql.org). H2 is part of the package, so you can start right off using it without the hassle of installing and configuring a database.

SQLstore is heavily inspired by

* [ringo-hibernate] by Robert Thurnher
* [Helma] (the predecessor of RingoJS)
* [Hibernate] Project

Status
======
## Status

Ringo SQLstore is experimental beta, so expect bugs and performance issues as well as significant API changes.
Although Ringo SQLstore is pre-1.0, it has been used in production in various applications for several years now. Nevertheless chances are that on the way to version 1.0 there will be incompatible API changes.

Documentation
====================
## Documentation

Documentation is available at https://github.com/grob/ringo-sqlstore/wiki

## Acknowledgements

SQLstore is heavily inspired by

[RingoJS]: http://ringojs.org/
[ringo-hibernate]: http://github.com/robi42/ringo-hibernate/
[Helma]: http://helma.org
[Hibernate]: http://hibernate.org/
[database]: http://github.com/grob/ringo-sqlstore/tree/master/lib/ringo/storage/sql/databases/
* [[ringo-hibernate | http://github.com/robi42/ringo-hibernate/]] by Robert Thurnher
* [[Helma | http://helma.org]] (the predecessor of RingoJS)
* [[Hibernate | http://hibernate.org]] Project

0 comments on commit 3a0523c

Please sign in to comment.