Skip to content

Commit

Permalink
v1.2: Remove all example/demo related files from master branch; move …
Browse files Browse the repository at this point in the history
…source in src/,

move distribution files into dist/; update README
  • Loading branch information
James Warwood committed Aug 4, 2014
1 parent 0e8b673 commit 1df6a19
Show file tree
Hide file tree
Showing 63 changed files with 1,735 additions and 2,239 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,26 @@ To view jQuery Page Walkthrough example <a href="example/example.html">Click Her
## Screenshots

### Modal-style tour step
![Modal-style step](images/screenshot_modal.png 'Modal-style step')
![Modal-style step](assets/screenshot_modal.png 'Modal-style step')

### Tooltip-style tour step with highlighted content
![Tooltip-style step](images/screenshot_tooltip.png 'Tooltip-style step')
![Tooltip-style step](assets/screenshot_tooltip.png 'Tooltip-style step')

## Install

1. Download the release you want from the [releases page](https://github.com/warby-/jquery-pagewalkthrough/releases), or download the
[latest code](https://github.com/warby-/jquery-pagewalkthrough/archive/master.zip)(may not be stable).
2. Extract the files from the `dist/` folder into your project
3. Include the stylesheets and JS (**note: include jQuery first**):

```html
<!-- CSS -->
<link type="text/css" rel="stylesheet" href="css/jquery.pagewalkthrough.css" />
<link type="text/css" rel="stylesheet" href="path/to/extracted/files/css/jquery.pagewalkthrough.css" />

<!-- JQUERY -->
<script type="text/javascript" src="js/jquery-1.7.2.min.js"></script>
<script type="text/javascript" src="js/jquery.pagewalkthrough-1.1.0.js"></script>
<!-- jQuery -->
<script type="text/javascript" src="path/to/jquery/jquery-<jquery_version>.js"></script>
<!-- Page walkthrough plugin -->
<script type="text/javascript" src="path/to/extracted/files/jquery.pagewalkthrough-1.1.0.js"></script>
```

## jQuery Page Walkthrough Default Options
Expand Down Expand Up @@ -111,6 +117,10 @@ Will be added soon...

## Changelog

### 04/08/2014

* v1.2.0: Remove demo/example related files from master branch; source files into src/; distribution files into dist/

### 30/07/2014

* v1.1.4: Add option to make close button optional
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions plugins/jquery.pagewalkthrough.js → dist/jquery.pagewalkthrough.js
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
* Contributors: James Warwood <[email protected]>
* Craig Roberts <[email protected]>
* Created On: 27/02/2013
* Version: 1.1.4
* Issue, Feature & Bug Support: erwin.yusrizal@gmail.com
* Version: 1.2
* Issue, Feature & Bug Support: https://github.com/warby-/jquery-pagewalkthrough/issues
***/

;(function($, window, document, undefined) {
Expand Down
File renamed without changes.
Loading

0 comments on commit 1df6a19

Please sign in to comment.