jakearchibald / idb-keyval

A super-simple-small promise-based keyval store implemented with IndexedDB

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Publish a CHANGELOG

steelbrain opened this issue · comments

This is excellent package @jakearchibald! Thank you for working on it

Love the updates, I think a Changelog or release notes somewhere would make upgrades much easier for consumers.

What do you think?

There's already https://github.com/jakearchibald/idb-keyval#updating, or do you mean something different?

I had read the README several times but not seen it, while we're on the subject, maybe a Table of Contents for the README would be nice to have too :)

As for the changelog, this is what I had in mind:

At least some information about possible breaking changes would be nice. I'm not sure if I can easily update version of some package without breaking something. In changelog I can see what was changed and if i see something that i use changed - it means that I at least would need to do some refactoring to migrate.