Skip to content
This repository was archived by the owner on Oct 20, 2025. It is now read-only.

Commit 767f5a2

Browse files
Merge pull request #119 from inkonchain/chore/onchn-1085-archive-ink-kit
chore(ONCHN-1085): archive project and add modern alternatives to readme
2 parents 54c505d + 202ef95 commit 767f5a2

3 files changed

Lines changed: 36 additions & 22 deletions

File tree

.github/README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
<img src="../src/images/banner.webp" alt="Ink Kit Banner" style="width: 100%; border-radius: 8px; margin-bottom: 2rem;" />
22

3-
# Welcome to Ink Kit
3+
# Ink Kit
44

5-
Ink Kit is an onchain-focused SDK that delivers a delightful developer experience with ready-to-use app layout templates, themes, and magical animated components.
5+
> **Looking for React UI components?** The ecosystem has matured significantly with excellent options like [shadcn/ui](https://ui.shadcn.com/), [Radix UI](https://www.radix-ui.com/), [Chakra UI](https://chakra-ui.com/), and [Mantine](https://mantine.dev/). For wallet connectivity specifically, check out [RainbowKit](https://www.rainbowkit.com/) or [ConnectKit](https://docs.family.co/connectkit).
66
7-
## Install
7+
---
8+
9+
## About This Project
10+
11+
Ink Kit is a React component library that provided UI components, app layouts, and themes, plus a wallet connection component built on wagmi. Modern alternatives now offer better maintained solutions for both general UI and web3-specific needs.
12+
13+
## Installation
14+
15+
If you're maintaining an existing project using Ink Kit:
816

917
```bash
10-
npm install @inkonchain/ink-kit
18+
npm install @inkonchain/ink-kit@0.9.1-beta.19
1119
# or
12-
pnpm install @inkonchain/ink-kit
20+
pnpm install @inkonchain/ink-kit@0.9.1-beta.19
1321
```
1422

1523
## Usage
@@ -84,9 +92,9 @@ To see examples on specific colors that you can override, check the following [t
8492

8593
## Resources
8694

87-
- **Documentation**: Visit our [Storybook](https://ink-kit.inkonchain.com/)
88-
- **Contributing**: Visit our [GitHub repository](https://github.com/inkonchain/ink-kit)
95+
- **Storybook Documentation**: [ink-kit.inkonchain.com](https://ink-kit.inkonchain.com/)
96+
- **NPM Package**: [@inkonchain/ink-kit](https://www.npmjs.com/package/@inkonchain/ink-kit)
8997

90-
## WIP Notice
98+
---
9199

92-
This is a work in progress: we are constantly adding new components, improving the developer experience, and fixing bugs.
100+
This repository was archived in October 2025. The code remains available under the MIT license for anyone who wishes to reference or fork it.

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
1-
# Welcome to Ink Kit
1+
# Ink Kit
22

3-
Ink Kit is an onchain-focused SDK that delivers a delightful developer experience with ready-to-use app layout templates, themes, and magical animated components.
3+
> **Looking for React UI components?** The ecosystem has matured significantly with excellent options like [shadcn/ui](https://ui.shadcn.com/), [Radix UI](https://www.radix-ui.com/), [Chakra UI](https://chakra-ui.com/), and [Mantine](https://mantine.dev/). For wallet connectivity specifically, check out [RainbowKit](https://www.rainbowkit.com/) or [ConnectKit](https://docs.family.co/connectkit).
44
5-
## Install
5+
---
6+
7+
## About This Project
8+
9+
Ink Kit is a React component library that provided UI components, app layouts, and themes, plus a wallet connection component built on wagmi. Modern alternatives now offer better maintained solutions for both general UI and web3-specific needs.
10+
11+
## Using This Library
12+
13+
If you're maintaining an existing project using Ink Kit, the package remains available:
614

715
```bash
8-
npm install @inkonchain/ink-kit
9-
# or
10-
pnpm install @inkonchain/ink-kit
16+
npm install @inkonchain/ink-kit@0.9.1-beta.19
1117
```
1218

13-
## Resources
19+
**Resources:**
1420

15-
- **GitHub**: Visit our [GitHub](https://github.com/inkonchain/ink-kit) repository
16-
- **Documentation**: Visit our [Storybook](https://ink-kit.inkonchain.com/)
17-
- **Contributing**: Visit our [GitHub repository](https://github.com/inkonchain/ink-kit)
21+
- [Storybook Documentation](https://ink-kit.inkonchain.com/)
22+
- [GitHub Repository](https://github.com/inkonchain/ink-kit)
23+
- [NPM Package](https://www.npmjs.com/package/@inkonchain/ink-kit)
1824

19-
## WIP Notice
25+
---
2026

21-
This is a work in progress: we are constantly adding new components, improving the developer experience, and fixing bugs.
27+
This repository was archived in October 2025. The code remains available under the MIT license for anyone who wishes to reference or fork it.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@inkonchain/ink-kit",
33
"version": "0.9.1-beta.19",
4-
"description": "",
4+
"description": "React component library for onchain applications - See README for modern alternatives",
55
"main": "dist/index.cjs.js",
66
"module": "dist/index.es.js",
77
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)