Add note about Turbolinks 3 being work-in-progress

turbolinks · May 31, 2015 · 63c7837 · 63c7837 · gregblass · Jun 3, 2015
1 parent c0fffe0
commit 63c7837
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
-Turbolinks
-===========
+Turbolinks 3
+============
 [![Build Status](https://travis-ci.org/rails/turbolinks.svg?branch=master)](https://travis-ci.org/rails/turbolinks)
 
+**Note: Turbolinks 3 isn't production-ready yet. Expect breaking changes before the new version is released.**
+
 Turbolinks makes following links in your web application faster. Instead of letting the browser recompile the JavaScript and CSS between each page change, it keeps the current page instance alive and replaces only the body (or parts of) and the title in the head. Think CGI vs persistent process.
 
 This is similar to [pjax](https:/defunkt/jquery-pjax), but instead of worrying about what element on the page to replace and tailoring the server-side response to fit, we replace the entire body by default, and let you specify which elements to replace on an opt-in basis. This means that you get the bulk of the speed benefits from pjax (no recompiling of the JavaScript or CSS) without having to tailor the server-side response. It just works.