Confusing README
See original GitHub issueThe README now to refer to the upcoming 3.0.0 version, which has breaking changes, i.e. uses the open
method name, rather than the current version, which uses openDb
.
This is confusing to new users getting familiar with the API. Have you considered adding a warning to the README along with a pointer to https://github.com/jakearchibald/idb/blob/b17dfbde8a47967634b347634336b4b6034edcb4/README.md ?
Issue Analytics
- State:
- Created 5 years ago
- Comments:6 (3 by maintainers)
Top Results From Across the Web
Confusing readme after installing · Issue #29 · sanity-io/sanity ...
I installed the template as a starter from the sanity.io website. I must say it's an excellent DX and I soon had everyhting...
Read more >1465053 - Remove confusing README files from /mobile/android ...
Currently there are 2 README files [1], [2] inside this package which seem to contain outdated info: > These files are managed in...
Read more >node_modules/confusing-browser-globals/README.md ... - GitLab
This package exports a list of globals that are often used by mistake. You can feed this list to a static analysis tool...
Read more >JIRA standalone has misleading README and RELEASE ...
The JIRA standalone releases contain Tomcat's README.txt and RELEASE-NOTES-4.1.txt files, which I imagine is rather confusing for users at first.
Read more >Readme is confusing or wrong. [#2925793] | Drupal.org
Readme is confusing or wrong. Closed (fixed). Project: SMTP Authentication Support. Version: 8.x-1.x-dev. Component: Documentation.
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Good point, I’ve pushed a tag.
Thank you!
On Mon 14. Jan 2019 at 11:47, Jake Archibald notifications@github.com wrote: