From 37702d87da17c271a8aa1b481f77701503837c78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Rebours?= Date: Tue, 18 May 2021 15:14:34 +0200 Subject: [PATCH] changelog --- CHANGELOG.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 5 ++--- 2 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..be64188 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,52 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres +to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [2.0.0] - 2021-05-18 + +This version should be a drop-in replacement for `nedb@1.8.0` provided you use +modern browsers / versions of Node.js since ES6 features are now used (such +as `class` and `const` / `let`). + +### Changed + +- New maintainer [seald](https://github.com/seald/) and new package + name [@seald-io/nedb](https://www.npmjs.com/package/@seald-io/nedb); +- Added `lockfileVersion: 2` `package-lock.json`; +- Modernized some of the code with ES6 features (`class`, `const` & `let`); +- Uses [`standard`](https://standardjs.com/) to lint the code (which removes all + unnecessary semicolons); +- Updated dependencies, except `async` which stays at `0.2.10` for the moment; +- Stop including the browser version in the repository, and properly build it + with `webpack`; +- Uses `karma` to run the browser tests, and use npm to fetch versioned + dependencies rather than having hardcoded copies of the dependencies in the + repository; +- Internalized `exec-time` dependency for the benchmarks, because it was + unmaintained; +- Uses `@seald-io/binary-search-tree` rather than + unmaintained `binary-search-tree`; + +### Removed + +- Compatibility with old browsers and old version of Node.js that don't support + ES6 features. +- From now on, this package won't be published with `bower` as it became + essentially useless. +- Entries in the `browser` field of package.json don't include individual files, + only the bundled minified version, thos files are still published with the + package. + +### Security + +- This version no longer + uses [a vulnerable version of `underscore`](https://github.com/advisories/GHSA-cf4h-3jhx-xvhq) + . + +## [1.8.0] - 2016-02-15 + +See [original repo](https://github.com/louischatriot/nedb) diff --git a/README.md b/README.md index 0855d95..918fe81 100755 --- a/README.md +++ b/README.md @@ -13,11 +13,10 @@ browsers, 100% JavaScript, no binary dependency**. API is a subset of MongoDB's and it's [plenty fast](#speed). ## Installation, tests -Module name on npm and bower is `@seald-io/nedb`. +Module name on npm is `@seald-io/nedb`. ``` -npm install @seald-io/nedb --save # Put latest version in your package.json -npm test # You'll need the dev dependencies to launch tests +npm install @seald-io/nedb ``` ## API