Skip to content

Commit

Permalink
πŸ“ update README.md with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
PhearZero committed Aug 27, 2024
1 parent 654ae0b commit 548151d
Showing 1 changed file with 30 additions and 11 deletions.
41 changes: 30 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,32 @@ Projects like algokit, algosdk and algo-models could benefit from this approach
This approach is already used in algosdk but only for the models, we purpose also exporting the interface from the operations
definition.

# Get Started[WIP]
# TODO:

- [ ] Add tests
- [ ] Regenerate library without Class closures
- [ ] Allow decoding of `format=msgpack`
- [ ] Handle BigInt conversions

# Get Started

Login to [Github's Package Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)

```bash
npm login --scope=@awesome-algorand --auth-type=legacy --registry=https://npm.pkg.github.com
```

Install one of the packages

```bash
npm install @algofam/algod-fetch
npm install @algofam/indexer-fetch
npm install @algofam/kmd-fetch
npm install @awesome-algorand/algod-fetch
npm install @awesome-algorand/indexer-fetch
npm install @awesome-algorand/kmd-fetch
```

# Contributing[WIP]
See the [Reference Documentation](https://awesome-algorand.github.io/algo-fetch/) for more information

# Contributing

Clone the project

Expand All @@ -42,6 +60,12 @@ Install the dependencies
npm install
```

Run the release without publishing

```bash
./bin/publisher.js --skipNpm
```

## Commands

All projects share the same commands with the same intents
Expand Down Expand Up @@ -84,9 +108,4 @@ Runs the linter

```bash
npm run lint
```

# TODO:

- [ ] Automate the generation of the clients when the openapi schema changes, look into the action
- [ ] Add tests
```

0 comments on commit 548151d

Please sign in to comment.