Upd readme and changelog

This commit is contained in:
Anatoliy Chakkaev 2013-03-25 02:50:57 +04:00
parent 567de88a10
commit f35160d5e5
2 changed files with 20 additions and 10 deletions

View File

@ -1,11 +1,11 @@
## About [<img src="https://secure.travis-ci.org/1602/jugglingdb.png" />](http://travis-ci.org/#!/1602/jugglingdb) ## About [<img src="https://secure.travis-ci.org/1602/jugglingdb.png" />](http://travis-ci.org/#!/1602/jugglingdb)
JugglingDB is cross-db ORM for nodejs, providing **common interface** to access [JugglingDB(3)](http://jugglingdb.co) is cross-db ORM for nodejs, providing
most popular database formats. Currently supported are: mysql, sqlite3, **common interface** to access most popular database formats. Currently
postgres, couchdb, mongodb, redis, neo4j and js-memory-storage (yep, supported are: mysql, sqlite3, postgres, couchdb, mongodb, redis, neo4j and
self-written engine for test-usage only). You can add your favorite database js-memory-storage (yep, self-written engine for test-usage only). You can add
adapter, checkout one of the existing adapters to learn how, it's super-easy, I your favorite database adapter, checkout one of the existing adapters to learn
guarantee. how, it's super-easy, I guarantee.
Jugglingdb also works on client-side (using WebService and Memory adapters), Jugglingdb also works on client-side (using WebService and Memory adapters),
which allows to write rich client-side apps talking to server using JSON API. which allows to write rich client-side apps talking to server using JSON API.
@ -257,9 +257,9 @@ user.save(callback);
// afterSave // afterSave
// callback // callback
user.updateAttribute('email', 'email@example.com', callback); user.updateAttribute('email', 'email@example.com', callback);
// beforeUpdate
// beforeValidation // beforeValidation
// afterValidation // afterValidation
// beforeUpdate
// afterUpdate // afterUpdate
// callback // callback
user.destroy(callback); user.destroy(callback);
@ -275,7 +275,7 @@ User.create(data, callback);
``` ```
Read the tests for usage examples: ./test/common_test.js Read the tests for usage examples: ./test/common_test.js
Validations: ./test/validations_test.js Validations: ./test/validations.test.js
## Your own database adapter ## Your own database adapter

View File

@ -3,9 +3,15 @@ jugglingdb-changelog(3) - The History of JugglingDB
## HISTORY ## HISTORY
### upcoming release ### upcoming release 0.3.0
* Documentation in [web][http://jugglingdb.co] and man * Documentation:
Available in [web](http://jugglingdb.co) and man [jugglingdb(3)]
* **Hooks**:
Changed format of update and save hooks. Hook accept data as second argument.
This data could be modified and it will be saved to database after hook done.
**NOTE**: this change could break some code.
### 0.2.1 ### 0.2.1
@ -70,3 +76,7 @@ jugglingdb-changelog(3) - The History of JugglingDB
### 0.0.1 ### 0.0.1
Package extracted from [RailwayJS MVC](http://railwayjs.com) Package extracted from [RailwayJS MVC](http://railwayjs.com)
## SEE ALSO
jugglingdb-roadmap(3)