Skip to content

Commit

Permalink
Release 1.0.1-alpha.8
Browse files Browse the repository at this point in the history
Added better instructions to readme
  • Loading branch information
Seth Webster committed Dec 23, 2015
1 parent 80f5332 commit b797451
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,37 @@ A convention-based version update notifier.

## Usage

Add this add-on as you would any other:

1. Add this add-on as you would any other:
```bash
> ember install ember-cli-new-version
```
ember install ember-cli-new-version

2. Add a version file to your app, eg:
_./public/VERSION.txt_

```bash
1.0.0
```

Include the component in your view:
3. Include the component in your view:
```handlebars
{{ember-cli-new-version}}
```

**viola**!

### Options ###
----
* updateInterval - the amount of time, in milliseconds, to wait between version checks **default: 5000**
* versionFileName - the name of the file on the server to check **default: /VERSION.txt**
* updateMessage - the message to show to users when update has been detected. There are two tokens allowed in this string: ```{{newVersion}}``` and ```{{oldVersion}}``` which will replaced with their respective values.
eg. (and **default**). "This application has been updated from version {{oldVersion}} to {{newVersion}}. Please save any work, then refresh browser to see changes."
* showReload - _true_ shows a reload button the user can click to refresh. _false_ hides the button. **default: true**

```handlebars
{{ember-cli-new-version updateInterval=<value> versionFileName="<value>" updateMessage="<value>" showReload=true}}
```

## Contributing

* `git clone` this repository
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ember-cli-new-version",
"version": "1.0.1-alpha.7",
"version": "1.0.1-alpha.8",
"description": "A convention based update notification for Ember. With this addon, you can detect a new version and notify the user to refresh the page",
"directories": {
"doc": "doc",
Expand Down

0 comments on commit b797451

Please sign in to comment.