diff --git a/README.md b/README.md index 510707bc..1085d044 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ Try the [interactive tutorial](http://gun.js.org/think.html) in the browser (**5 Jump right into the [gun playground](http://jsbin.com/miredog/edit?js,console) and start testing whatever functions you want. +Quick note: All active development is happening on `0.5` branch, which has the upcoming **30M+ ops/sec** performance improvements! + ## Table of Contents - [Demos](#demos) - [Videos](#videos) @@ -67,8 +69,10 @@ Jump right into the [gun playground](http://jsbin.com/miredog/edit?js,console) a ### Projects - GUN users are encouraged to add their projects to this [running projects list](https://github.com/amark/gun/wiki/projects). -## How to get started - - Until we complete the [Getting Started with GUN](https://github.com/amark/gun/wiki/getting-started-(v0.3.x)) Guide, please review the [API documentation](https://github.com/amark/gun/wiki/API-(v0.3.x)) and [examples' source code](https://github.com/amark/gun/blob/master/examples). +## Docs & Tradeoffs + - [Getting Started with GUN](https://github.com/amark/gun/wiki/getting-started-(v0.3.x)) Guide. + - [API documentation](https://github.com/amark/gun/wiki/API-(v0.3.x)) and [examples' source code](https://github.com/amark/gun/blob/master/examples). + - GUN is an AP system which means you should not use it for banking apps, [learn more here](https://github.com/amark/gun/wiki/CAP-Theorem). - Check out and add example code [snippets](https://github.com/amark/gun/wiki/snippets-(v0.3.x)) —including micro-modules— to address specific situations. ## Modules