-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
86e447b
commit 5350f4e
Showing
2 changed files
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
|
||
build/ | ||
node_modules/ | ||
example/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,28 @@ | ||
# NodeJS Driver for CrossDB | ||
|
||
## Pre-requirement | ||
You need to [install](https://crossdb.org/get-started/install/) crossdb lib first | ||
You need to [install](https://crossdb.org/get-started/install/) crossdb lib first | ||
|
||
> ### Not ready for production | ||
## Install | ||
```sh | ||
npm install @croosdb/crossdb-nodejs | ||
``` | ||
### to Use | ||
|
||
```javascript | ||
const CrossDB = require('@croosdb/crossdb-nodejs'); | ||
|
||
const db = new CrossDB(':memory:'); | ||
// or | ||
const db = new CrossDB('./<<path>>/<<db name>>'); | ||
``` | ||
|
||
> not ready for production | ||
|
||
## Run Example | ||
|
||
```sh | ||
npm install | ||
npm start | ||
npm install | ||
npm start | ||
``` |