From b7325a110eb28976ba993eb05ae706b267a224b4 Mon Sep 17 00:00:00 2001 From: Anatoliy Chakkaev Date: Sat, 23 Mar 2013 22:51:39 +0400 Subject: [PATCH] Added some initial docs --- .gitignore | 2 + docs/changelog.md | 17 ++++ docs/html/index.html | 197 +++++++++++++++++++++++++++++++++++++++++++ docs/index.txt | 9 ++ docs/jugglingdb.md | 101 ++++++++++++++++++++++ docs/roadmap.md | 29 +++++++ 6 files changed, 355 insertions(+) create mode 100644 docs/changelog.md create mode 100644 docs/html/index.html create mode 100644 docs/index.txt create mode 100644 docs/jugglingdb.md create mode 100644 docs/roadmap.md diff --git a/.gitignore b/.gitignore index f8f6df66..db02cd10 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,5 @@ v8.log .DS_Store benchmark.js analyse.r +docs/html +docs/man diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 00000000..36a5233a --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,17 @@ +jugglingdb-changelog(3) - The History of JugglingDB +=================================================== + +## HISTORY + +### upcoming release + +### 0.2.1 + +### 0.2.0 + +### 0.1.27 +### 0.1.23 +### 0.1.21 +### 0.1.1 +### 0.0.4 +### 0.0.2 diff --git a/docs/html/index.html b/docs/html/index.html new file mode 100644 index 00000000..be1ed638 --- /dev/null +++ b/docs/html/index.html @@ -0,0 +1,197 @@ + + + + + + JugglingDB(3) - cross-database ORM for nodejs and browser + + + + + +
+ + + +
    +
  1. JugglingDB(3)
    2. +
  2. JugglingDB
    3. +
  3. JugglingDB(3)
    4. +
+ +

NAME

+

+ JugglingDB - cross-database ORM for nodejs and browser +

+ +

DESCRIPTION

+ +

JugglingDB is cross-db ORM for nodejs, providing common interface to access +most popular database formats. Currently supported are: mysql, sqlite3, +postgres, couchdb, mongodb, redis, neo4j and in-memory-storage.

+ +

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.

+ +

INSTALLATION

+ +

Use npm to install core package:

+ +
npm install jugglingdb --save
+
+ +

Alternatively you can install jugglingdb core from github:

+ +
npm install 1602/jugglingdb
+
+ +

Then install adapter for specific database, for example jugglingdb-redis:

+ +
npm install jugglingdb-redis
+
+ +

See jugglingdb-adapters(3) for list of available adapters.

+ +

DOCUMENTATION

+ +

Autogenerated documentation available at jsdoc.info/1602/jugglingdb. Human-written manual sections are:

+ +
+
jugglingdb-schema(3)

Everything about schema, data types and model definition.

+
jugglingdb-model(3)

Model methods, features and internals.

+
jugglingdb-validations(3)

Built-in validators, creating custom validations, syncronous and asyncronous +object validation.

+
jugglingdb-hooks(3)

Hooks and object lifecycle.

+
+ + +

ADAPTERS

+ +

CONTRIBUTION

+ +

FUTURE

+ +

See jugglingdb-roadmap(3) and [github issues][issues] to catch up current +development and see how you can help jugglingdb to grow up.

+ +

BUGS

+ +

When you find issues, please report them:

+ +
+
github/core
https://github.com/1602/jugglingdb/issues
+
github/adapters
https://github.com/jugglingdb
+
email
compoundjs@googlegroups.com
+
+ + +

HISTORY

+ +

See jugglingdb-changelog(3)

+ +

LICENSE

+ +

JugglingDB has MIT license, see jugglingdb-license(3) for details.

+ +

AUTHOR

+ + + + +

CONTRIBUTORS

+ +

core contributors (more than 1%)

+ +
410 Anatoliy Chakkaev       73.9%
+ 31 Sébastien Drouyer      5.6%
+ 25 1602                    4.5%
+  9 Muneeb Samuels          1.6%
+  6 Henri Bergius           1.1%
+
+ +

adapters maintainers

+ + + + +

SEE ALSO

+ + +
    +
  1. 1602 Software
    2. +
  2. March 2013
    3. +
  3. JugglingDB(3)
    4. +
+ +
+ + diff --git a/docs/index.txt b/docs/index.txt new file mode 100644 index 00000000..e30d28dc --- /dev/null +++ b/docs/index.txt @@ -0,0 +1,9 @@ +jugglingdb(3) index +jugglingdb-changelog(3) changelog.3 +jugglingdb-roadmap(3) roadmap.3 +jugglingdb-validations(3) validations.3 +jugglingdb-hooks(3) hooks.3 +jugglingdb-schema(3) schema.3 +jugglingdb-model(3) model.3 + +jugglingdb-nano https://github.com/jugglingdb/nano-adapter diff --git a/docs/jugglingdb.md b/docs/jugglingdb.md new file mode 100644 index 00000000..d2fcc1d1 --- /dev/null +++ b/docs/jugglingdb.md @@ -0,0 +1,101 @@ +JugglingDB(3) - cross-database ORM for nodejs and browser +========================================================= + +## DESCRIPTION + +JugglingDB is cross-db ORM for nodejs, providing **common interface** to access +most popular database formats. Currently supported are: mysql, sqlite3, +postgres, couchdb, mongodb, redis, neo4j and in-memory-storage. + +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. + + +## INSTALLATION + +Use npm to install core package: + + npm install jugglingdb --save + +Alternatively you can install jugglingdb core from github: + + npm install 1602/jugglingdb + +Then install adapter for specific database, for example `jugglingdb-redis`: + + npm install jugglingdb-redis + +See jugglingdb-adapters(3) for list of available adapters. + +## DOCUMENTATION + +Autogenerated documentation available at [jsdoc.info/1602/jugglingdb](https://jsdoc.info/1602/jugglingdb). Human-written manual sections are: + +* jugglingdb-schema(3): + Everything about schema, data types and model definition. + +* jugglingdb-model(3): + Model methods, features and internals. + +* jugglingdb-validations(3): + Built-in validators, creating custom validations, syncronous and asyncronous + object validation. + +* jugglingdb-hooks(3): + Hooks and object lifecycle. + +## ADAPTERS + +## CONTRIBUTION + +## FUTURE + +See jugglingdb-roadmap(3) and [github issues][issues] to catch up current +development and see how you can help jugglingdb to grow up. + +## BUGS + +When you find issues, please report them: + +* github/core: + +* github/adapters: + +* email: + + +## HISTORY + +See jugglingdb-changelog(3) + +## LICENSE + +JugglingDB has MIT license, see jugglingdb-license(3) for details. + +## AUTHOR + +* [blog](http://anatoliy.in/) +* [github/1602](https://github.com/1602/) +* [github/anatoliychakkaev](https://github.com/anatoliychakkaev/) +* [twitter@1602](http://twitter.com/1602) +* + +## CONTRIBUTORS + +### core contributors (more than 1%) + 410 Anatoliy Chakkaev 73.9% + 31 Sébastien Drouyer 5.6% + 25 1602 4.5% + 9 Muneeb Samuels 1.6% + 6 Henri Bergius 1.1% + +### adapters maintainers + +* [jugglingdb-nano] - [Nicholas Westlake](https://github.com/nrw) +* [jugglingdb-mysql] - [dgsan](https://github.com/dgsan) +* [jugglingdb-firebird] - [Henri Gourvest](https://github.com/hgourvest) + +*NOTE:* Other adapters waits for their maintainers, drop a line to +mail@anatoliy.in if you want to maintain some adapter on regular basis. + +## SEE ALSO diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 00000000..43617852 --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,29 @@ +jugglingdb-roadmap - The Future of JugglingDB +============================================= + +## DOCUMENTATION + +### ENGINE + +* web +* man + +### SECTIONS + +* hooks +* validations +* schema +* model +* adapters +* testing + +## MODEL CORE + +* virtual attributes +* object presentation modes +* mass-assignment protection +* destroy by query + +## SCHEMA + +* models merging