You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+7-18
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,11 @@ A collection of typescript and frontend packages for working with [RMRK EVM NFTs
7
7
8
8
## Packages
9
9
10
-
-[@rmrk-team/ipfs-utils](./packages/ipfs-utils) - IPFS utils for RMRK EVM NFTs
10
+
-[@rmrk-team/ipfs-utils](./packages/ipfs-utils) - IPFS utils for RMRK EVM NFTs (WIP)
11
11
-[@rmrk-team/nft-renderer](./packages/nft-renderer) - React component that fetches NFT data and assets and renders 2d renderer
12
-
-[@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
13
-
-[@rmrk-team/rmrk-hooks](./packages/rmrk-hooks) - Collection of react hooks for working with RMRK EVM NFTs
14
-
-[@rmrk-team/types](./packages/types) - Common Typescript types for RMRK EVM NFTs
12
+
-[@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
13
+
-[@rmrk-team/rmrk-hooks](./packages/rmrk-hooks) - Collection of react hooks for working with RMRK EVM NFTs (WIP)
14
+
-[@rmrk-team/types](./packages/types) - Common Typescript types for RMRK EVM NFTs (WIP)
15
15
16
16
## Example apps
17
17
@@ -22,7 +22,7 @@ A collection of typescript and frontend packages for working with [RMRK EVM NFTs
22
22
See individual package READMEs for usage instructions.
23
23
24
24
### composable-nft-renderer-app
25
-
To run example app, run `pnpm dev:react` from root directory.
25
+
To run example app, run `pnpm dev:react` from root directory. Then view in browser, for example https://localhost:3002/base/0x011ff409bc4803ec5cfab41c3fd1db99fd05c004/399
26
26
27
27
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`.
28
28
@@ -33,19 +33,8 @@ This project uses [Biome.js](https://biomejs.dev) for code formatting (instead o
33
33
## Publishing a release
34
34
35
35
Build all packages and generate a new changeset
36
-
```bash
37
-
pnpm install && pnpm build && pnpm changeset
38
-
```
39
-
40
-
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.
41
-
```bash
42
-
pnpm changeset version
43
-
```
44
-
45
-
Check the git diff and commit the changelog, then finally publish all packages to npm
46
-
```bash
47
-
pnpm publish -r --access=public
48
-
```
36
+
37
+
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
0 commit comments