Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuripetusko authored Jan 24, 2024
1 parent f8cc428 commit ad96831
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ A collection of typescript and frontend packages for working with [RMRK EVM NFTs

## Packages

- [@rmrk-team/ipfs-utils](./packages/ipfs-utils) - IPFS utils for RMRK EVM NFTs
- [@rmrk-team/ipfs-utils](./packages/ipfs-utils) - IPFS utils for RMRK EVM NFTs (WIP)
- [@rmrk-team/nft-renderer](./packages/nft-renderer) - React component that fetches NFT data and assets and renders 2d renderer
- [@rmrk-team/rmrk-2d-renderer](./packages/rmrk-2d-renderer) - Pixi.js based 2d composable renderer. Takes an array of AssetParts as input and renders them on HTML canvas
- [@rmrk-team/rmrk-hooks](./packages/rmrk-hooks) - Collection of react hooks for working with RMRK EVM NFTs
- [@rmrk-team/types](./packages/types) - Common Typescript types for RMRK EVM NFTs
- [@rmrk-team/rmrk-2d-renderer](./packages/rmrk-2d-renderer) - Pixi.js based 2d composable renderer. Takes an array of AssetParts as input and renders them on HTML canvas. Usually not used on it's own
- [@rmrk-team/rmrk-hooks](./packages/rmrk-hooks) - Collection of react hooks for working with RMRK EVM NFTs (WIP)
- [@rmrk-team/types](./packages/types) - Common Typescript types for RMRK EVM NFTs (WIP)

## Example apps

Expand All @@ -22,7 +22,7 @@ A collection of typescript and frontend packages for working with [RMRK EVM NFTs
See individual package READMEs for usage instructions.

### composable-nft-renderer-app
To run example app, run `pnpm dev:react` from root directory.
To run example app, run `pnpm dev:react` from root directory. Then view in browser, for example https://localhost:3002/base/0x011ff409bc4803ec5cfab41c3fd1db99fd05c004/399

This app uses [Panda.css](https://panda-css.com) and [Ark.ui](https://ark-ui.com) for styling. When running the dev server, styles will automatically re-generate using postcss when appropriate files are changed, however if you need to manually generate styles, run `pnpm panda:prepare`.

Expand All @@ -33,19 +33,8 @@ This project uses [Biome.js](https://biomejs.dev) for code formatting (instead o
## Publishing a release

Build all packages and generate a new changeset
```bash
pnpm install && pnpm build && pnpm changeset
```

Create a new version from the changeset. Interactive prompt will appear, use spacebar to select All packages, then in most cases skip major and minor version (press enter instead of spacebar), this will fallback to `patch` semver.
```bash
pnpm changeset version
```

Check the git diff and commit the changelog, then finally publish all packages to npm
```bash
pnpm publish -r --access=public
```

When submitting a PR with a change that requires a new version, please run `pnpm changesets` and select appropriate type of version bump (major, minor or patch if none is selected). When PR is merged, the new version will be automatically published to npm


## Credits:
Expand Down

0 comments on commit ad96831

Please sign in to comment.