Skip to content

Commit

Permalink
Add CHANGES file (covering since v0.13.0); easier MD listing standards
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed Mar 20, 2016
1 parent 52f5c01 commit f69e352
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .remarkrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
"plugins": {
"lint": {
"no-multiple-toplevel-headings": false,
"ordered-list-marker-value": "one"
"ordered-list-marker-value": "one",
"list-item-spacing": false,
"list-item-indent": "space"
}
}
}
40 changes: 40 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# CHANGES

## Unreleased

- Docs: Badges, CHANGES
- Testing improvements: Travis, Grunt

## 0.14.0 (March 8, 2016)

- Enhancement: Add `addEventListener`, `removeEventListener` and
`abort`/`error`/`versionchange` short equivalents;
- Docs: Clarify README re: recovering from blocked events
- Testing improvements

## 0.13.2 (March 2, 2016)

- Fix: Address issue [#144](https://github.com/aaronpowell/db.js/issues/144)
by ensuring transaction error handlers are affixed before any
transactional work
- Coding improvements

## 0.13.1 (March 2, 2016)

- Enhancement: Add `newVersion` and `oldVersion` where not supported
- Testing and coding improvements: Karma/Saucelabs/Grunt/PhantomJS,
service workers

## 0.13.0 (March 1, 2016)

- Enhancement: Add blocked event handler to open() and delete() (with docs and
tests) allowing additional "resume" promise property for user to easily
resume promise chain (if blocking undone by closing old db connection)
- Cache server by version as well as name to allow upgrades of same name
(and document);
- Enhancement: Support web workers/service workers and add tests
- Enhancement: Allow for consistent promise use (including for errors),
deferring the error in the case of query preparation until execution
- Docs and coding improvements
- Testing improvements (Karma, Saucelabs, change to Mocha/Chai, unique
test ids)
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ db.open({

Note that `open()` takes an options object with the following properties:

- *version* - The current version of the database to open.
- *version* - The current version of the database to open.
Should be an integer. You can start with `1`. You must increase the `version`
if updating the schema or otherwise the `schema` property will have no effect.

- *server* - The name of this server. Any subsequent attempt to open a server
- *server* - The name of this server. Any subsequent attempt to open a server
with this name (and with the current version) will reuse the already opened
connection (unless it has been closed).

- *schema* - Expects an object, or, if a function is supplied, a schema
- *schema* - Expects an object, or, if a function is supplied, a schema
object should be returned). A schema object optionally has store names as
keys (these stores will be auto-created if not yet added). The values of
these schema objects should be objects, optionally with the property "key"
Expand Down Expand Up @@ -559,9 +559,9 @@ library.

# Contributor notes

- `npm install` to install all the dependencies
- `npm run grunt test:local` to run the mocha server
- Open (`http://localhost:9999/tests`)[] to run the mocha tests
- `npm install` to install all the dependencies
- `npm run grunt test:local` to run the mocha server
- Open (`http://localhost:9999/tests`)[] to run the mocha tests

# License

Expand Down

0 comments on commit f69e352

Please sign in to comment.