From baa42c74a794254f763518eecb3abb3589c23abc Mon Sep 17 00:00:00 2001 From: Marius Olbertz Date: Tue, 23 May 2017 11:55:25 +0200 Subject: [PATCH] Added demo page, fixed casing for "Joyride" --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 88edd6a..3b768ea 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # Joyride Joyride is an easy to configure site tour wizard for [Foundation for Sites](https://github.com/zurb/foundation-sites). +## Demo +You can try out Joyride on the [Demo Page](http://zurb.github.io/joyride/). + ## Installation -To install joyride you can either use NPM (comming soon) or download the files directly. +To install Joyride you can either use NPM ([NPM repository](https://www.npmjs.com/package/foundation-joyride)) or download the files directly. * `npm start` - Calls the build process and opens the demo in your browser. * `npm test` - Runs the JavaScript tests. @@ -13,13 +16,13 @@ To install joyride you can either use NPM (comming soon) or download the files d ## Usage All versions of joyride depend on jQuery and [what-input](https://github.com/ten1seven/what-input). While jQuery is mandatory, what-input is used for styling purposes and not necessary for joyride to work. -Regardless of the way you use joyride, you need to initialize it like all Foundation plugins by calling: +Regardless of the way you use Joyride, you need to initialize it like all Foundation plugins by calling: ```js $(document).foundation(); ``` -The following HTML is an example on how to use joyride. You can also have a look at the visual test cases in the `test/visual/` folder. +The following HTML is an example on how to use Joyride. You can also have a look at the visual test cases in the `test/visual/` folder. ```html
    @@ -42,12 +45,12 @@ The following HTML is an example on how to use joyride. You can also have a look ``` ### Foundation plugin -Originally, joyride is a plugin for Foundation for Sites and leaverages existing plugins and functionalities of the framework. -To use joyride with Foundation, just include the files into your page right after the Foundation files. Then follow the example above to create the ride. +Originally, Joyride is a plugin for Foundation for Sites and leaverages existing plugins and functionalities of the framework. +To use Joyride with Foundation, just include the files into your page right after the Foundation files. Then follow the example above to create the ride. ### Standalone plugin -To make joyride available for a broader amount of users, it is also available as a standalone plugin. All relevant Foundation functionalities are bundled with the joyride files, so joyride can still benefit from them. -To use joyride with Foundation, just include the files into your page right and follow the example above to create the ride. +To make Joyride available for a broader amount of users, it is also available as a standalone plugin. All relevant Foundation functionalities are bundled with the Joyride files, so Joyride can still benefit from them. +To use Joyride with Foundation, just include the files into your page right and follow the example above to create the ride. ### Using script loader Joyride can be used by including its files via HTML-tags and also the most popular script loaders, such as RequireJS. This is done by leveraging UMD. @@ -59,4 +62,4 @@ Joyride can be used by including its files via HTML-tags and also the most popul ## Contributing -Check out our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute to this plugin. You can also browse the [Help Wanted](https://github.com/zurb/joyride/labels/help%20wanted) tag in our issue tracker to find things to do. \ No newline at end of file +Check out our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute to this plugin. You can also browse the [Help Wanted](https://github.com/zurb/joyride/labels/help%20wanted) tag in our issue tracker to find things to do.