-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
85e8bd2
commit 85e7be6
Showing
2 changed files
with
20 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,30 @@ | ||
[![CI](https://github.com/ordzaar/ordit-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/ordzaar/ordit-sdk/actions/workflows/ci.yml) | ||
|
||
# Ordit | ||
|
||
Ordit is an SDK project for Bitcoin Wallet, Ordinals and Inscriptions | ||
|
||
### Pre-Requisites | ||
## Setup | ||
|
||
This project is setup with [pnpm workspaces](https://pnpm.io/workspaces) and [turbo](https://turbo.build/). It follows a monorepo architecture for all its applications. | ||
|
||
This project uses PNPM to manage dependencies. | ||
In this workspace, you can refer to [pnpm-workspace.yaml](pnpm-workspace.yaml) on how the project is structured. | ||
|
||
```shell | ||
$ npm i -g pnpm | ||
```txt | ||
packages/ | ||
├─ sdk/ | ||
``` | ||
|
||
### Setup | ||
### Developing & Contributing | ||
|
||
Thanks for contributing, appreciate all the help we can get. Feel free to make a pull-request, we will guide you along | ||
the way to make it mergeable. | ||
|
||
### Prerequisites | ||
|
||
Install and build dependencies across all project folders: | ||
You'll need to have `pnpm` installed on your system. If it's not yet installed, you can get it via npm using: | ||
|
||
```sh | ||
$ pnpm install | ||
```bash | ||
npm install -g pnpm | ||
pnpm i | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters