Skip to content

Commit

Permalink
chore(ops): scaffold library
Browse files Browse the repository at this point in the history
  • Loading branch information
thedoublejay committed Oct 18, 2023
1 parent 85e8bd2 commit 85e7be6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
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
```
1 change: 1 addition & 0 deletions turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"inputs": ["src/**", "**/*.unit.ts"],
"dependsOn": ["^build"]
},
"format": {},
"lint": {
"outputs": []
}
Expand Down

0 comments on commit 85e7be6

Please sign in to comment.