diff --git a/docs/ga.html b/docs/ga.html new file mode 100644 index 00000000..b60093b8 --- /dev/null +++ b/docs/ga.html @@ -0,0 +1,10 @@ + diff --git a/docs/html/index.html b/docs/html/index.html deleted file mode 100644 index 981f993a..00000000 --- a/docs/html/index.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - JugglingDB(3) - cross-database ORM for nodejs and browser - - - - - - -
- - - -
    -
  1. JugglingDB(3)
  2. -
  3. JugglingDB
  4. -
  5. JugglingDB(3)
  6. -
- -

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.

-
jugglingdb-adapter(3)

Adapter API explained.

-
- - -

ADAPTERS

- -

All adapters available as separate packages at -github.com/jugglingdb and published in npm.

- - - - -

CONTRIBUTION

- -

TODO: briefly describe contribution

- -

FUTURE

- -

See jugglingdb-roadmap(3) and github 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
-
- - -

Provide test case for reproducing error. When reporting issue to core mention -adapter where problem could be reproduced.

- -

HISTORY

- -

See jugglingdb-changelog(3)

- - - -

JugglingDB is Copyright (C) 2011 Anatoliy Chakkaev http://anatoliy.in

- -

AUTHOR

- - - - -

CONTRIBUTORS

- -

core contributors (more than 1%)

- -
410 Anatoliy Chakkaev       73.9%
- 31 Sebastien Drouyer       5.6%
- 25 1602                    4.5%
-  9 Muneeb Samuels          1.6%
-  6 Henri Bergius           1.1%
-
- -

adapters maintainers

- - - - -

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

- - -
    -
  1. 1602 Software
  2. -
  3. March 2013
  4. -
  5. JugglingDB(3)
  6. -
- -
- - diff --git a/scripts/doc.sh b/scripts/doc.sh index 56dca422..8ff5d315 100755 --- a/scripts/doc.sh +++ b/scripts/doc.sh @@ -19,10 +19,11 @@ case $dest in ;; *.html) - ronn -5 $1 --pipe\ + (ronn -5 $1 --pipe\ --style='print toc'\ --organization=1602\ Software\ - --manual=JugglingDB > $2 + --manual=JugglingDB &&\ + cat docs/ga.html) > $2 exit $? ;; esac