Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tot-kristian authored Jul 24, 2024
1 parent edbeff4 commit f08bb21
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Nodb JS/TS
# Nodb JS/TS Sdk

Nodb NPM is a wrapper for [nodb API](https://github.com/nearup-io/nodb). It allows you to do CRUD operations over your Postgres database via API directly. Nodb keeps track of vector embeddings using pgvector so that you can do retrieval-augmented generation (RAG) using vector search.
Nodb offers real-time updates using websockets by connecting to the Nodb API and subscribing to changes.
Expand All @@ -24,17 +24,17 @@ Nodb supports both ESM and CommonJS modules, allowing you to integrate it seamle
First install the NPM package (e.g. with npm, yarn, pnpm, bun):

```bash
npm install nodb-js
npm install nodb-js-sdk
```

## Getting Started

To begin using NodbSDK, import the Nodb class:

```typescript
import Nodb from "nodb-js";
import Nodb from "nodb-js-sdk";
//OR
const Nodb = require("nodb-js");
const Nodb = require("nodb-js-sdk");
```
If you're using import you should add "type": "module" to package.json.
You need to create an instance of Nodb now:
Expand Down

0 comments on commit f08bb21

Please sign in to comment.