Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ node_modules/
package-lock.json
root.json
tests/immudb
tests/test-data
.nyc_output
.vscode/
tests/root.json
Expand All @@ -10,4 +11,4 @@ root
rootfile
examples/.env
.env
dist/
dist/
6 changes: 6 additions & 0 deletions DEPLOY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
1. create the version branch
2. update package.json with the correct version
3. merge the version branch to master (do not delete the branch)
4. create the release in GH
5. release in GH
6. npm publish from the CLI
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

## Introduction

immudb-node implements a [grpc] immudb client. A minimalist API is exposed for applications while cryptographic verifications and state update protocol implementation are fully implemented by this client. Latest validated immudb state may be keep in the local filesystem when initialising the client with the rootPath option, please read [immudb research paper] for details of how immutability is ensured by [immudb].
immudb-node implements a [grpc] immudb client. A minimalist API is exposed for applications while cryptographic verifications and state update protocol implementation are fully implemented by this client. Latest validated immudb state may be kept in the local filesystem when initialising the client with the rootPath option. Please read [immudb research paper] for details on how immutability is ensured by [immudb].

[grpc]: https://grpc.io/
[immudb research paper]: https://immudb.io/
Expand All @@ -49,7 +49,7 @@ const ImmudbClient = require('immudb-node')

immudb-node supports the [latest immudb release].

[latest immudb release]: https://github.com/codenotary/immudb/releases/tag/v0.9.1
[latest immudb release]: https://github.com/codenotary/immudb/releases/latest

## Quickstart

Expand Down Expand Up @@ -139,8 +139,8 @@ cl.useDatabase('db1')
### Traditional read and write

immudb provides read and write operations that behave as a traditional
key-value store i.e. no cryptographic verification is done. This operations
may be used when validations can be post-poned:
key-value store i.e. no cryptographic verification is done. These operations
may be used when validating can be postponed:

```
let res = await cl.set({ key: 'key1', value: 'value1' })
Expand Down
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "immudb-node",
"version": "1.1.0",
"name": "@codenotary/immudb-node",
"version": "1.1.2",
"description": "Node.js SDK for immudb written in TypeScript",
"directories": {
"src": "src",
Expand All @@ -20,19 +20,18 @@
"devDependencies": {
"@types/btoa": "^1.2.3",
"@types/google-protobuf": "^3.15.2",
"@types/lodash": "^4.14.170",
"@types/lodash": "^4.17.10",
"@types/mocha": "^8.2.2",
"@types/node": "^14.17.3",
"@types/tap": "^14.10.3",
"@typescript-eslint/eslint-plugin": "^3.9.0",
"@typescript-eslint/parser": "^3.9.0",
"crypto-ts": "^1.0.2",
"grpc": "^1.24.10",
"grpc-tools": "^1.11.1",
"grpc_tools_node_protoc_ts": "^5.0.1",
"grpc-tools": "^1.11.1",
"protobufjs": "6.10.1",
"tap": "15.0.9",
"typescript": "^3.9.7"
"typescript": "^4.9.5"
},
"dependencies": {
"@grpc/grpc-js": "1.2.0",
Expand Down
Loading