@@ -5,6 +5,14 @@ This package offers complete bindings and type-safety upon the [IndexedDB API](h
55
66## Overview
77
8+The `IDBCore` and `IDBFactory` are the two entry points required to create and connect to an
9+indexed database. From there, modules are divided such that each of them covers a specific IDB
10+interface.
11+
12+They are designed to be used as qualified imports such that each method gets prefixed with a
13+menaingful namespace (e.g `IDBIndex.get`, `IDBObjectStore.openCursor` ...)
14+
15+Here's a quick example of what it look likes.
816```purescript
917main :: Eff (idb :: IDB, exception :: EXCEPTION, console :: CONSOLE) Unit
1018main = launchAff' do
@@ -27,14 +35,28 @@ onUpgradeNeeded db _ = launchAff' do
2735 pure unit
2836```
2937
30−## Changelog
38+## Notes
3139
32−- Release incoming
40+### Errors
41+Errors normally thrown by the IDB\* interfaces are wrapped in the `Aff` Monad as `Error`
42+where the `message` corresponds to the error's name (e.g. "InvalidStateError").
43+Pattern matching can therefore be done on any error message to handle specific errors thrown
44+by the API.
45+
46+### Examples
47+The `test` folder contains a great amount of examples showing practical usage of the IDB\*
48+interfaces. Do not hesitate to have a peek should you wonder how to use one of the module. The
49+wrapper tries to keep as much as possible an API consistent with the original IndexedDB API.
50+Hence, it should be quite straightforward to translate any JavaScript example to a PureScript
51+one.
52+
53+## Changelog
3354
34−#### TODO
55+#### v0.9.0
3556
36−- Add support for `index.getAll` method
37−- Complete the specifications with the [official tests list](https://github.com/w3c/web-platform-tests/blob/master/IndexedDB/README.md) provided by W3C
57+- [Indexed Database API 2.0](https://w3c.github.io/IndexedDB/) totally covered apart from
58+ - `index.getAll` method (and the associated one for the IDBObjectStore)
59+ - binary keys
3860
3961## Documentation
4062