fauna-shell - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

package.json

 {
   "name": "fauna-shell",
   "description": "faunadb shell",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "author": "Alvaro Videla",
@@ -6,0 +6,0 @@ "bin": {

README.md

@@ -24,2 +24,3 @@ fauna-shell
 * [Command Details](#command-details)
+* [Connecting to your local FaunaDB instance](#connecting-to-your-local-fauna-db-instance)
 * [List of Commands](#list-of-commands)
@@ -113,7 +114,7 @@ <!-- tocstop -->
 
-See [Commands](#commands) for a list of commnads and help on their usage.
+See [Commands](#commands) for a list of commands and help on their usage.
 
 # Shell
 
-The Fauna Shell lets you issue queries directly to your FaunaDB instance without the need for installing additinal libraries.
+The Fauna Shell lets you issue queries directly to your FaunaDB instance without the need for installing additional libraries.
 
@@ -134,3 +135,3 @@ Let's create a database and then we'll jump straight into the Shell to start playing with FaunaDB's data model.
 
-Once you have the prompt ready, you can start issues queries against your FaunaDB instance. (Note that the results shown here might vary from the ones ytou see while running the examples).
+Once you have the prompt ready, you can start issues queries against your FaunaDB instance. (Note that the results shown here might vary from the ones you see while running the examples).
 
@@ -275,2 +276,15 @@ ```javascript
 ```
+
+# Connecting to your local FaunaDB instance
+
+All the commands support the following options, in case you want them to connect to your local FaunaDB instance.
+
+```
+OPTIONS
+  --domain=domain      [default: db.fauna.com] FaunaDB server domain
+  --port=port          [default: 443] Connection port
+  --scheme=https|http  [default: https] Connection scheme.
+  --timeout=timeout    [default: 80] Connection timeout in milliseconds
+```
+
 <!-- detailsstop -->
@@ -313,3 +327,3 @@ # List of Commands
 
-_See code: [src/commands/create-database.js](https://github.com/fauna/fauna-shell/blob/v0.0.4/src/commands/create-database.js)_
+_See code: [src/commands/create-database.js](https://github.com/fauna/fauna-shell/blob/v0.0.5/src/commands/create-database.js)_
 
@@ -342,3 +356,3 @@ ## `fauna create-key DBNAME [ROLE]`
 
-_See code: [src/commands/create-key.js](https://github.com/fauna/fauna-shell/blob/v0.0.4/src/commands/create-key.js)_
+_See code: [src/commands/create-key.js](https://github.com/fauna/fauna-shell/blob/v0.0.5/src/commands/create-key.js)_
 
@@ -370,3 +384,3 @@ ## `fauna delete-database DBNAME`
 
-_See code: [src/commands/delete-database.js](https://github.com/fauna/fauna-shell/blob/v0.0.4/src/commands/delete-database.js)_
+_See code: [src/commands/delete-database.js](https://github.com/fauna/fauna-shell/blob/v0.0.5/src/commands/delete-database.js)_
 
@@ -398,3 +412,3 @@ ## `fauna delete-key KEYNAME`
 
-_See code: [src/commands/delete-key.js](https://github.com/fauna/fauna-shell/blob/v0.0.4/src/commands/delete-key.js)_
+_See code: [src/commands/delete-key.js](https://github.com/fauna/fauna-shell/blob/v0.0.5/src/commands/delete-key.js)_
 
@@ -440,3 +454,3 @@ ## `fauna help [COMMAND]`
 
-_See code: [src/commands/list-databases.js](https://github.com/fauna/fauna-shell/blob/v0.0.4/src/commands/list-databases.js)_
+_See code: [src/commands/list-databases.js](https://github.com/fauna/fauna-shell/blob/v0.0.5/src/commands/list-databases.js)_
 
@@ -465,3 +479,3 @@ ## `fauna list-keys`
 
-_See code: [src/commands/list-keys.js](https://github.com/fauna/fauna-shell/blob/v0.0.4/src/commands/list-keys.js)_
+_See code: [src/commands/list-keys.js](https://github.com/fauna/fauna-shell/blob/v0.0.5/src/commands/list-keys.js)_
 
@@ -493,3 +507,3 @@ ## `fauna shell DBNAME`
 
-_See code: [src/commands/shell.js](https://github.com/fauna/fauna-shell/blob/v0.0.4/src/commands/shell.js)_
+_See code: [src/commands/shell.js](https://github.com/fauna/fauna-shell/blob/v0.0.5/src/commands/shell.js)_
 <!-- commandsstop -->

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

Improved metrics

Total package byte prevSize

23056

increased by2.32%

Number of lines in readme file

499

increased by2.89%

No dependency changes