Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlit0eth authored Aug 27, 2024
1 parent 9acdd12 commit bdddeb0
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# @useorbis/db-sdk
OrbisDB SDK to create, manage and query open data.
# OrbisDB SDK
<img src="https://github.com/user-attachments/assets/cd407120-c733-4b0b-b9e7-aa622677bb05" height="80%" width="80%" >

> [!WARNING]
> This SDK is a work-in-progress and is being developed in parallel with the OrbisDB node.\
> Things will change, however, the core components have been ported over from the Orbis Social SDK and should have a stable-enough interface.\
> Find any notable or breaking changes in [CHANGELOG.md](/CHANGELOG.md).
OrbisDB SDK is a client-side complement to OrbisDB - a relational database designed for onchain builders.

Our SDK is offering an ORM-like approach and abstracts away complexity from the development process by offering a very well-known framework (INSERT, UPDATE, SELECT). Start your project easily with a Postgres database, authentication, and signatures.

Full SDK documentation is accessible here: [Getting started](https://www.notion.so/Getting-started-12a929384dd644fd9618b2d8e62ddda9?pvs=21)

> [!IMPORTANT]
> 🚨 OrbisDB SDK also integrates with a dashboard for easier access and management. Get an early access of our hosted service provided by Orbis: [OrbisDB Studio](https://studio.useorbis.com/).
## Installation

The SDK is available publicly on NPM. You can install it using your preferred package manager.

npm install @useorbis/db-sdk

> [!WARNING]
> This SDK is a work in progress and is being developed in parallel with the OrbisDB node.\
> Things will change, however, the core components have been ported over from the Orbis Social SDK and should have a stable-enough interface.\
> Find any notable or breaking changes in [CHANGELOG.md](/CHANGELOG.md).
>
## Description
OrbisDB SDK is a client-side complement to OrbisDB - a decentralized database built on top of Ceramic.\
It inherits the DX of our TS SDK which enables simple user authentication while providing new (more generic) methods to manipulate data.
Expand Down

0 comments on commit bdddeb0

Please sign in to comment.