From b321cfbf0de195b0625cc83a7e53f73a23e04d37 Mon Sep 17 00:00:00 2001 From: Mike McNeil Date: Thu, 16 Feb 2017 11:46:26 -0600 Subject: [PATCH] As exciting as the 'bonus track' in the README was, this pulls it out into ROADMAP.md to avoid confusion --- README.md | 133 ----------------------------------------------------- ROADMAP.md | 27 +++++++++++ 2 files changed, 27 insertions(+), 133 deletions(-) diff --git a/README.md b/README.md index b3699ed6f..33064dd50 100644 --- a/README.md +++ b/README.md @@ -57,136 +57,3 @@ All tests are written with [mocha](https://mochajs.org/) and should be run with [Waterline](http://waterlinejs.org), like the rest of the [Sails framework](http://sailsjs.com), is free and open-source under the [MIT License](http://sailsjs.com/license). ![image_squidhome@2x.png](http://sailsjs.com/images/bkgd_squiddy.png) - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - -  - - - - -## Experimental features - -Below, you'll find a handful of experimental features that you might enjoy. - -> Please be aware that these are in the early stages and should not be relied upon -> as production features of Waterline. They could change at any time-- even on a patch -release! **You have been warned!** - -#### Experimental lifecycle and accessor methods - -```js -var Waterline = require('waterline'); -``` - -+ `Waterline.start(opts, function(err, orm) { /*...*/ })` -+ `Waterline.stop(orm, function(err) { /*...*/ })` -+ `Waterline.getModel(modelIdentity, orm)` - -> For detailed usage, see the source code (bottom of `lib/waterline.js` in this repo.) diff --git a/ROADMAP.md b/ROADMAP.md index 188805792..cacc6424f 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -78,3 +78,30 @@ Feature | Summary Do not mess with identity case | Identities of models should not be lowercased per default, better be left as defined. See [issue](https://github.com/balderdashy/waterline/issues/745) for more details. Support JSONB in PostgreSQL | Add support for JSONB querying in the Postgres adapter. This requires modifing/extending the criteria language. See [issue](https://github.com/balderdashy/sails-postgresql/issues/212) for more details. Deep populate | [#1052](https://github.com/balderdashy/waterline/pull/1052) | Recursively populate child associations. + + + + +  +  + + +## Experimental features + +Below, you'll find a handful of experimental features. If you're interested in them, please try them out and provide [feedback](http://twitter.com/sailsjs)! It helps the core team and other open-source contributors from the community prioritize our efforts, and it lets us know what works and what doesn't. (As always, we welcome your [contributions](http://sailsjs.com/contribute)!) + +> Please be aware that these are in the early stages and should not be relied upon +> as production features of Waterline. They could change at any time-- even on a patch +release! **You have been warned!** + +#### Experimental lifecycle and accessor methods + +```js +var Waterline = require('waterline'); +``` + ++ `Waterline.start(opts, function(err, orm) { /*...*/ })` ++ `Waterline.stop(orm, function(err) { /*...*/ })` ++ `Waterline.getModel(modelIdentity, orm)` + +> For detailed usage, see the source code (bottom of `lib/waterline.js` in this repo.)