Skip to content

Commit 5350f4e

Browse files
committed
add .npmignore
1 parent 86e447b commit 5350f4e

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

.npmignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
build/
3+
node_modules/
4+
example/

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
# NodeJS Driver for CrossDB
22

33
## Pre-requirement
4-
You need to [install](https://crossdb.org/get-started/install/) crossdb lib first
4+
You need to [install](https://crossdb.org/get-started/install/) crossdb lib first
5+
6+
> ### Not ready for production
7+
8+
## Install
9+
```sh
10+
npm install @croosdb/crossdb-nodejs
11+
```
12+
### to Use
13+
14+
```javascript
15+
const CrossDB = require('@croosdb/crossdb-nodejs');
16+
17+
const db = new CrossDB(':memory:');
18+
// or
19+
const db = new CrossDB('./<<path>>/<<db name>>');
20+
```
521

6-
> not ready for production
722

823
## Run Example
924

1025
```sh
11-
npm install
12-
npm start
26+
npm install
27+
npm start
1328
```

0 commit comments

Comments
 (0)