Skip to content

Commit

Permalink
Tweak README ordering and text. (#234)
Browse files Browse the repository at this point in the history
- Moves the `Themes` section below `Configuration`.
- Adjust attention of required `steps` and the way `defaults` needs be set before it.
  • Loading branch information
BrianSipple authored and RobbieTheWagner committed Sep 5, 2018
1 parent f85fb8c commit f9ebce6
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Ember-shepherd
# ember-shepherd

<a href="https://shipshape.io/"><img src="http://i.imgur.com/KVqNjgO.png" alt="Ship Shape" width="100" height="100"/></a>

Expand Down Expand Up @@ -44,21 +44,10 @@ export default Component.extend({
})
```

## Themes

Shepherd has several built in themes. By default, we include the `'arrows'` theme. You can specify which theme to include in `ember-cli-build.js` like so:

```js
var app = new EmberApp(defaults, {
shepherd: {
theme: 'dark'
}
});
```

## Configuration

The following configuration options can be `set` on the Tour service to control the way that Shepherd is used. The only required option is `steps`, which you can read more about below.
The following configuration options can be `set` on the Tour service to control the way that Shepherd is used. **The only required option is `steps`, which you can read more about below.**

### confirmCancel

Expand All @@ -75,7 +64,7 @@ is set to true.
`defaults` is used to set the options that will be applied to each step by default.
You can pass in any of the options that you can with Shepherd.

## You must set defaults *BEFORE* setting steps
**⚠️ You must set defaults *BEFORE* setting steps.**

It will be an object of a form something like:

Expand Down Expand Up @@ -320,6 +309,20 @@ Currently does ***not*** accept htmlbars input (PR welcome).

An object that contains function to be executed when events occur on the step. Supported events are `before-show`, `show`, `before-hide`, `hide`, `complete`, `cancel`, and `destroy`.


## Themes

Shepherd has several built in themes. By default, we include the `'arrows'` theme. You can specify which theme to include in `ember-cli-build.js` like so:

```js
var app = new EmberApp(defaults, {
shepherd: {
theme: 'dark'
}
});
```


## Interacting with `ember-shepherd`

`ember-shepherd` uses the [`Ember.Evented`](http://emberjs.com/api/classes/Ember.Evented.html) mixin to manage events. The API is demonstrated below.
Expand Down

0 comments on commit f9ebce6

Please sign in to comment.