Skip to content

Commit 499eff3

Browse files
committed
Update readme a bit
1 parent 6400df3 commit 499eff3

File tree

7 files changed

+20
-5
lines changed

7 files changed

+20
-5
lines changed

README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22

33
A collection of typescript and frontend packages for working with [RMRK EVM NFTs](https://https://evm.rmrk.app).
44

5+
---
6+
57
> Note: Do not try to update `next.js` version, it's confirmed that `next@^13.4` will cause a constant object in `@pixi/core` become empty after `npm run build`.
68
79

810
## Packages
911

10-
- [@rmrk-team/ipfs-utils](./packages/ipfs-utils) - IPFS utils for RMRK EVM NFTs (WIP)
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. 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)
12+
- [@rmrk-team/nft-renderer](./packages/nft-renderer) - React component that fetches NFT data and assets and renders 2d renderer <a href="https://www.npmjs.com/package/@rmrk-team/nft-renderer"><picture><source srcset="https://img.shields.io/npm/v/@rmrk-team/nft-renderer?style=flat"><img src="https://img.shields.io/npm/v/@rmrk-team/nft-renderer?style=flat" alt="Version"></picture></a>
13+
- [@rmrk-team/rmrk-hooks](./packages/rmrk-hooks) - Collection of React hooks for working with RMRK EVM NFTs (WIP) <a href="https://www.npmjs.com/package/@rmrk-team/rmrk-hooks"><picture><source srcset="https://img.shields.io/npm/v/@rmrk-team/rmrk-hooks?style=flat"><img src="https://img.shields.io/npm/v/@rmrk-team/rmrk-hooks?style=flat" alt="Version"></picture></a>
14+
- [@rmrk-team/rmrk-evm-utils](./packages/rmrk-evm-utils) - Typescript utils and actions for RMRK EVM NFTs (WIP) <a href="https://www.npmjs.com/package/@rmrk-team/rmrk-evm-utils"><picture><source srcset="https://img.shields.io/npm/v/@rmrk-team/rmrk-evm-utils?style=flat"><img src="https://img.shields.io/npm/v/@rmrk-team/rmrk-evm-utils?style=flat" alt="Version"></picture></a>
15+
- [@rmrk-team/ipfs-utils](./packages/ipfs-utils) - IPFS utils for RMRK EVM NFTs (WIP) <a href="https://www.npmjs.com/package/@rmrk-team/ipfs-utils"><picture><source srcset="https://img.shields.io/npm/v/@rmrk-team/ipfs-utils?style=flat"><img src="https://img.shields.io/npm/v/@rmrk-team/ipfs-utils?style=flat" alt="Version"></picture></a>
16+
- [@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 <a href="https://www.npmjs.com/package/@rmrk-team/rmrk-2d-renderer"><picture><source srcset="https://img.shields.io/npm/v/@rmrk-team/rmrk-2d-renderer?style=flat"><img src="https://img.shields.io/npm/v/@rmrk-team/rmrk-2d-renderer?style=flat" alt="Version"></picture></a>
17+
- [@rmrk-team/types](./packages/types) - Common Typescript types for RMRK EVM NFTs (WIP) <a href="https://www.npmjs.com/package/@rmrk-team/types"><picture><source srcset="https://img.shields.io/npm/v/@rmrk-team/types?style=flat"><img src="https://img.shields.io/npm/v/@rmrk-team/types?style=flat" alt="Version"></picture></a>
1518

1619
## Example apps
1720

packages/ipfs-utils/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
[![npm version](https://img.shields.io/npm/v/@rmrk-team/rmrk-hooks.svg?style=flat)](https://www.npmjs.com/package/@rmrk-team/ipfs-utils)
44

5+
---
6+
57
Utilities for working with NFT metadata and media stored on ipfs.
68

79
## Installation

packages/nft-renderer/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
React component for rendering multi-layered composable 2d [RMRK](https://evm.rmrk.app) EVM NFTs.
66

7+
---
8+
79
## Installation
810

911
```bash

packages/rmrk-2d-renderer/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
A Pixi (Canvas) based renderer for multilayered and composable [RMRK](https://evm.rmrk.app) EVM NFTs. This package doesn't interact with the chain, and is usually used in combination with [@rmrk-team/nft-renderer](/packages/nft-renderer).
66

7+
---
8+
79
## Installation
810

911
```bash

packages/rmrk-evm-utils/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
Typescript utilities for [RMRK](https://evm.rmrk.app) EVM NFTs.
66

7+
---
8+
79
## Installation
810

911
```bash

packages/rmrk-hooks/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
React hooks for working with [RMRK](https://evm.rmrk.app) EVM NFTs.
66

7+
---
8+
79
## Installation
810

911
```bash

packages/types/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
Common Typescript types for [RMRK](https://evm.rmrk.app) EVM NFTs.
66

7+
---
8+
79
## Installation
810

911
```bash

0 commit comments

Comments
 (0)