diff --git a/README.md b/README.md index 0e74d6e9..dd98d921 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,24 @@ StoryKit is a React toolkit that allows builders to integrate and interact with Story's Proof of Creativity protocol with prebuilt IP management components. -## Installation +## 📋 Overview -_StoryKit is currently a GitHub Package so you will need repo access and a personal access token to use._ +StoryKit provides: +- Ready-to-use components for IP asset management +- Blockchain integration for creative work protection +- Simple API for interacting with Story protocol +- Customizable UI components + +## ⚡ Requirements + +- Node.js 20 or higher +- React 17 or higher +- GitHub repository access +- TypeScript support (recommended) + +## 🚀 Installation + +_StoryKit is currently available as a GitHub Package, so you will need repository access and a personal access token._ Also you will need Node.js 20+. @@ -27,6 +42,40 @@ The first line authenticates you with the GitHub package registry, the second li npm install @storyprotocol/storykit @tanstack/react-query react-force-graph-2d ``` +## 💡 Usage Examples + +### Basic Example + +```tsx +import { IpWidget } from "@storyprotocol/storykit"; + +function App() { + return ( + + ); +} +``` + +### Custom Theme + +```tsx +import { IpWidget, createTheme } from "@storyprotocol/storykit"; + +const customTheme = createTheme({ + colors: { + primary: "#1a73e8", + secondary: "#188038", + }, +}); + +function App() { + return ; +} +``` + ## Getting Started ### API Keys @@ -169,6 +218,20 @@ See [the github repo](https://github.com/storyprotocol/storykit) and [the exampl - Lint: pnpm run lint - Format: pnpm run format -## Contributing +## 🤝 Contributing + +We welcome community contributions! Before you start: + +1. Make sure you've read [CONTRIBUTING.md](./CONTRIBUTING.md) +2. Check existing issues and pull requests +3. Discuss major changes in issues before starting work + +## 📝 License + +MIT License - see the [LICENSE](./LICENSE) file for details. + +## 🔗 Useful Links -For guidelines on contributing to StoryKit, see the [CONTRIBUTING.md](./CONTRIBUTING.md) file. +- [Official Documentation](https://docs.storyprotocol.xyz) +- [Example Applications](https://github.com/storyprotocol/storykit/tree/main/examples) +- [Story Protocol](https://www.storyprotocol.xyz)