bitabase-gateway - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

index.js

@@ -20,3 +20,3 @@ if (process.env.NODE_ENV === 'development') {
 Commands:
-  start                            Start the bitabase manager stack
+  start                            Start the bitabase gateway stack
     --bind-host                    Hostname to bind server to (default: 0.0.0.0)
@@ -23,0 +23,0 @@ --bind-port                    Port to bind server to (default: 8001)

package.json

 {
   "name": "bitabase-gateway",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -11,2 +11,46 @@ # bitabase - Gateway
 
+## Getting Started
+### From the CLI
+Running the following:
+```bash
+npm install --global bitabase-gateway
+bitabase-gateway --help
+```
+
+Will output the below:
+```bash
+📦 Bitabase-Gateway - v1.5.1
+The scalable, sharded database engine.
+https://docs.bitabase.com
+
+The following commands and arguments are available when starting Bitabase
+
+Commands:
+  start                            Start the bitabase gateway stack
+    --bind-host                    Hostname to bind server to (default: 0.0.0.0)
+    --bind-port                    Port to bind server to (default: 8001)
+    --rqlite-addr                  Path to contact rqlite
+    --secret                       The internal request secret
+    --account-mapper               The regex to take the account from the incoming host (default: (.*).bitabase.test)
+
+No command specified
+```
+
+You can start a bitabase gateway server by running:
+
+```bash
+bitabase-gateway start
+```
+
+### From NodeJS
+```javascript
+const bitabaseServer = require('bitabase-gateway/server');
+
+const server = bitabasegateway({
+  bindHost: '0.0.0.0'
+});
+
+server.start();
+```
+
 ## Endpoints
@@ -13,0 +57,0 @@

No alert changes

Improved metrics

Total package byte prevSize

77130

increased by1.44%

Number of lines in readme file

85

increased by107.32%

No dependency changes