diff --git a/.github/README.md b/.github/README.md index fa27ff5..de05584 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,15 +1,23 @@ Ink Kit Banner -# Welcome to Ink Kit +# Ink Kit -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. +> **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). -## Install +--- + +## About This Project + +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. + +## Installation + +If you're maintaining an existing project using Ink Kit: ```bash -npm install @inkonchain/ink-kit +npm install @inkonchain/ink-kit@0.9.1-beta.19 # or -pnpm install @inkonchain/ink-kit +pnpm install @inkonchain/ink-kit@0.9.1-beta.19 ``` ## Usage @@ -84,9 +92,9 @@ To see examples on specific colors that you can override, check the following [t ## Resources -- **Documentation**: Visit our [Storybook](https://ink-kit.inkonchain.com/) -- **Contributing**: Visit our [GitHub repository](https://github.com/inkonchain/ink-kit) +- **Storybook Documentation**: [ink-kit.inkonchain.com](https://ink-kit.inkonchain.com/) +- **NPM Package**: [@inkonchain/ink-kit](https://www.npmjs.com/package/@inkonchain/ink-kit) -## WIP Notice +--- -This is a work in progress: we are constantly adding new components, improving the developer experience, and fixing bugs. +This repository was archived in October 2025. The code remains available under the MIT license for anyone who wishes to reference or fork it. diff --git a/README.md b/README.md index f880f3f..8fe0730 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,27 @@ -# Welcome to Ink Kit +# Ink Kit -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. +> **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). -## Install +--- + +## About This Project + +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. + +## Using This Library + +If you're maintaining an existing project using Ink Kit, the package remains available: ```bash -npm install @inkonchain/ink-kit -# or -pnpm install @inkonchain/ink-kit +npm install @inkonchain/ink-kit@0.9.1-beta.19 ``` -## Resources +**Resources:** -- **GitHub**: Visit our [GitHub](https://github.com/inkonchain/ink-kit) repository -- **Documentation**: Visit our [Storybook](https://ink-kit.inkonchain.com/) -- **Contributing**: Visit our [GitHub repository](https://github.com/inkonchain/ink-kit) +- [Storybook Documentation](https://ink-kit.inkonchain.com/) +- [GitHub Repository](https://github.com/inkonchain/ink-kit) +- [NPM Package](https://www.npmjs.com/package/@inkonchain/ink-kit) -## WIP Notice +--- -This is a work in progress: we are constantly adding new components, improving the developer experience, and fixing bugs. +This repository was archived in October 2025. The code remains available under the MIT license for anyone who wishes to reference or fork it. diff --git a/package.json b/package.json index 1933b9f..27772f5 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@inkonchain/ink-kit", "version": "0.9.1-beta.19", - "description": "", + "description": "React component library for onchain applications - See README for modern alternatives", "main": "dist/index.cjs.js", "module": "dist/index.es.js", "types": "dist/index.d.ts",