From b4c8aea2790d9e9ff9e7fe634f560801a2b61a53 Mon Sep 17 00:00:00 2001 From: Ross Allen Date: Sun, 3 May 2015 11:16:56 -0700 Subject: [PATCH] Reference Turbolinks early to note plugin --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 54e76de..b0325ce 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -# turbo-react +# TurboReact -turbo-react applies only the differences between two HTML pages when navigating +TurboReact applies only the differences between two HTML pages when navigating with links rather than create a new document, which enables CSS transitions between pages without needing a server. ## Installation & Usage -Include TurboReact in the `` of every document on your site. If you're using -Jekyll (GitHub Pages), use a layout in the `_layouts` directory to write the -script tag only once. +TurboReact is a plugin for [Turbolinks](https://github.com/rails/turbolinks), +which means Turbolinks is required. Include both Turbolinks and TurboReact in +the `` of every document on your site. If you're using Jekyll (GitHub +Pages), use a layout in the `_layouts` directory to write the script tag only +once. 1. Get turbo-react via NPM or download the latest release from GitHub: