Skip to content
This repository has been archived by the owner on Jun 18, 2019. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
mikermcneil committed Mar 11, 2016
1 parent 7bac5ab commit 506d0e1
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Waterline 2.0 Draft
# waterline2

> Waterline2 is not currently ready for production use yet; this repo is a draft and proposal. If you're using Waterline today, you should definitely visit the [stable v0.x Waterline code base here](https://github.com/balderdashy/waterline).
> If you're using Waterline today, you should definitely visit the [stable v0.x Waterline code base here](https://github.com/balderdashy/waterline) if you haven't already.
>
> That said if you are interested in contributing to features like recursive joins (aka "populate deep"), advanced aggregations, and WHERE subqueries, the many months of research and toil in this repo is the place to start.
Still curious? Okay. First, see [Introduction to Waterline2](./Introduction to Waterline2.pdf) for background on what this even is. Then see see ROADMAP.md for what's planned and the contribution guidelines. Feel free to send suggestions, etc. as PRs. If you've caught the bug and are interested in becoming a bigger part of the project, please reach out to @mikermcneil, @particlebanana, or @sgress454 on Twitter.
Still curious? You should read [this GitHub issue](https://github.com/balderdashy/waterline/pull/1052#issuecomment-195144878).

## Stilllllllllllllll curious??!!!?!?

Okay. First, check out [Introduction to Waterline2](./Introduction to Waterline2.pdf) for background on what this even is. Then see see ROADMAP.md for what's planned and the contribution guidelines. Feel free to send suggestions, etc. as PRs. If you've caught the bug and are interested in becoming a bigger part of the project, please reach out to @mikermcneil, @particlebanana, or @sgress454 on Twitter.

If you're feeling experimental, you [can actually use parts of WL2 in your existing Sails app right now](./USAGE_WITH_SAILS), as long as you're using the >=0.10.x version of Waterline and/or Sails. There are some pretty heavy crutches involved, and it's not particularly easy to set up right now, but cool to see nonetheless. And obviously extremely important for testing if you're looking to get involved as a contributor. Check out [USAGE_WITH_SAILS.md](./USAGE_WITH_SAILS.md) for details. As long as you're comfortable with `npm link`, you should have no problem getting it to work.

Expand Down

0 comments on commit 506d0e1

Please sign in to comment.