Skip to content

Commit

Permalink
Version 4.0.1.
Browse files Browse the repository at this point in the history
- Fixed markdown issues in the generated readme.
  • Loading branch information
jaydenseric committed Nov 20, 2016
1 parent 20859d2 commit 03c4e59
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hurdler",
"version": "4.0.0",
"version": "4.0.1",
"description": "Hurdler makes nested UI interactions simple to manage via URL hash.",
"author": {
"name": "Jayden Seric",
Expand Down Expand Up @@ -43,7 +43,7 @@
"predocs": "npm run lint:docs",
"docs": "documentation readme src --section API --quiet",
"postdocs": "npm run tidydocs",
"tidydocs": "tidy-markdown < ./readme.md > ./readme-tidy.md && mv -f readme-tidy.md readme.md",
"tidydocs": "sed -i '' '/Generated by documentation.js/d' ./readme.md && tidy-markdown < ./readme.md > ./readme-tidy.md && mv -f readme-tidy.md readme.md",
"prepublish": "npm run build"
},
"devDependencies": {
Expand Down
16 changes: 7 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Hurdler](https://cdn.rawgit.com/jaydenseric/Hurdler/v4.0.0/hurdler-logo.svg)
# ![Hurdler](https://cdn.rawgit.com/jaydenseric/Hurdler/v4.0.1/hurdler-logo.svg)

![NPM version](https://img.shields.io/npm/v/hurdler.svg?style=flat-square) ![Github issues](https://img.shields.io/github/issues/jaydenseric/Hurdler.svg?style=flat-square) ![Github stars](https://img.shields.io/github/stars/jaydenseric/Hurdler.svg?style=flat-square)

Expand All @@ -11,17 +11,17 @@ Hurdler makes nested UI interactions simple to manage via URL hash.

## How it works

1. A sprint is triggered manually or automatically when the URL hash changes with a valid target.
2. Hurdler sprints up the DOM from the target finding ancestor elements that match hurdles.
3. Jump callbacks run in top-down DOM order. Often components such as overlays need to be activated before descendants.

Lingo | Meaning
:----- | :--------------------------------------------------------------------
Target | A DOM element targeted via ID in the URL hash; the sprint start line.
Sprint | A sprint up the DOM, looking for hurdles from the target.
Hurdle | A test and stuff to do when a DOM element passes.
Jump | A hurdle that was found in a sprint.

1. A sprint is triggered manually or automatically when the URL hash changes with a valid target.
2. Hurdler sprints up the DOM from the target finding ancestor elements that match hurdles.
3. Jump callbacks run in top-down DOM order. Often components such as overlays need to be activated before descendants.

## Benefits

When components such as modals and slideshows are navigated via URL hash:
Expand Down Expand Up @@ -76,11 +76,9 @@ Run a first sprint, after DOM ready:
hurdler.sprint()
```

## API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## API

### Hurdler
### Hurdler

Creates a new Hurdler session. There should only be one instance per window.

Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*!
* Hurdler: https://github.com/jaydenseric/Hurdler
* @version v4.0.0
* @version v4.0.1
* @author Jayden Seric
* @license MIT
*/
Expand Down

0 comments on commit 03c4e59

Please sign in to comment.