klein - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

package.json

 {
   "name": "klein",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A small ORM that combines ImmutableJS and knex",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -37,5 +37,24 @@ # Klein
 
+The easiest init is:
+
 ```javascript
+// Assumes that process.env.DATABASE_URL is set
+const Klein = require('klein/auto');
+```
+
+But if you need to specify a database URL:
+
+```javascript
 const Klein = require('klein').connect(process.env.DATABASE_URL);
+```
 
+Or, if you already have an instanciated `knex` object:
+
+```javascript
+const Klein = require('klein').connect(knex);
+```
+
+Then you can define a model:
+
+```javascript
 const Users = Klein.model('users');
@@ -250,1 +269,6 @@ ```
 ```
+
+
+## TODO
+
+* Model validations

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52993

increased by0.99%

Number of package files

14

increased by16.67%

Lines of code

981

increased by0.31%

Number of lines in readme file

273

increased by9.64%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes