level-sublevel - npm Package Compare versions

Comparing version 6.3.2 to 6.3.4

package.json

 {
   "name": "level-sublevel",
   "description": "partition levelup databases",
-  "version": "6.3.2",
+  "version": "6.3.4",
   "homepage": "https://github.com/dominictarr/level-sublevel",
@@ -13,3 +13,3 @@ "repository": {
     "ltgt": "~1.0.2",
-    "levelup": "https://codeload.github.com/dominictarr/node-levelup/tar.gz/inject",
+    "levelup": "~0.19.0",
     "xtend": "~4.0.0"
@@ -16,0 +16,0 @@ },

README.md

@@ -6,2 +6,3 @@ # level-sublevel
 [![build status](https://secure.travis-ci.org/dominictarr/level-sublevel.png)](http://travis-ci.org/dominictarr/level-sublevel)
+
 [![testling badge](https://ci.testling.com/dominictarr/level-sublevel.png)](https://ci.testling.com/dominictarr/level-sublevel)
@@ -16,13 +17,29 @@
 
-The long awaited `level-sublevel` rewrite is nearly ready,
-infact - it is currently _available_,
-(`npm install level-sublevel@6`) but it is also a breaking
-change. So it's good to use it with a new project,
-but I recomment, for now, not upgrading projects that already
-use `level-sublevel@5`. The user api is the same as before,
-but the way that keys are encoded has changed, and _this means
-you cannot run 6 on a database you created with 5_,
-if you are using 5 and want to upgrade - please post an issue and 
-we'll talk it through
+The long awaited `level-sublevel` rewrite is out!
+You are hearby warned this is a _significant breaking_ change.
+So it's good to use it with a new project,
+The user api is the same as before,
+but the way that keys are _encoded_ has changed, and _this means
+you cannot run 6 on a database you created with 5_.
 
+### Legacy Mode
+
+Using leveldb with legacy mode is the simplest way to get the new sublevel
+on top of a database that used old sublevel. Simply require sublevel like this:
+
+``` js
+var level = require('level')
+                                   //  V *** require legacy.js ***
+var sublevel = require('level-sublevel/legacy')
+var db = sublevel(level(path))
+
+```
+
+### Migration Tool
+
+@calvinmetcalf has created a migration tool:
+[sublevel-migrate](https://github.com/calvinmetcalf/sublevel-migrate)
+
+This can be used to copy an old level-sublevel into a the format.
+
 ## Stability
@@ -32,3 +49,3 @@
 
-This is module is working well, but may change in the future as its use is futher explored.
+This module is working well, but may change in the future as its use is futher explored.
 
@@ -35,0 +52,0 @@ ## Example

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

HTTP dependency

Supply chain risk

Contains a dependency which resolves to a remote HTTP URL which could be used to inject untrusted code and reduce overall package reliability.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

143216

increased by91.44%

Number of package files

51

increased by2%

Number of lines in readme file

131

increased by14.91%

Number of high supply chain risk alerts

0

decreased by-100%

Dependency changes

• + Addedabstract-leveldown@0.12.4(transitive)

• + Addedbl@0.8.2(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addeddeferred-leveldown@0.2.0(transitive)

• + Addederrno@0.1.8(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedisarray@0.0.1(transitive)

• + Addedlevelup@0.19.1(transitive)

• + Addedprr@0.0.01.0.1(transitive)

• + Addedreadable-stream@1.0.34(transitive)

• + Addedsemver@5.1.1(transitive)

• + Addedstring_decoder@0.10.31(transitive)

• + Addedxtend@3.0.0(transitive)

• Updatedlevelup@~0.19.0