Skip to content

Commit

Permalink
add .npmignore
Browse files Browse the repository at this point in the history
  • Loading branch information
efremropelato committed Nov 18, 2024
1 parent 86e447b commit 5350f4e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
4 changes: 4 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

build/
node_modules/
example/
23 changes: 19 additions & 4 deletions README.md
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
```

0 comments on commit 5350f4e

Please sign in to comment.