diff --git a/README.md b/README.md index b5b2950..a9ab571 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,78 @@ -# sv +# @kredeum/wagmi-svelte5 -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +A Svelte 5 Web3 library based on Wagmi, providing seamless integration of Web3 functionality into your Svelte applications. -## Creating a project +## Features -If you're seeing this, you've probably already done this step. Congrats! +- 🔌 Built for Svelte 5 +- 🌐 Web3 Integration +- 🔒 Wallet Connection Management +- ⛓️ Multi-chain Support +- 🎣 Reactive Web3 Hooks +- 🔄 Auto-refresh on Network Changes + +## Installation ```bash -# create a new project in the current directory -npx sv create +npm install @kredeum/wagmi-svelte5 +# or +pnpm add @kredeum/wagmi-svelte5 +# or +yarn add @kredeum/wagmi-svelte5 +``` + +## Quick Start + +```typescript +import { createConfig } from '@kredeum/wagmi-svelte5'; -# create a new project in my-app -npx sv create my-app +// Configure your Web3 settings +const config = createConfig({ + // Your configuration options here +}); ``` -## Developing +## Usage -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +### Connect Wallet -```bash -npm run dev +```svelte + -# or start the server and open the app in a new browser tab -npm run dev -- --open + ``` -## Building +## Requirements + +- Svelte 5.x +- Node.js 16+ -To create a production version of your app: +## Development ```bash -npm run build +# Install dependencies +pnpm install + +# Run development server +pnpm dev + +# Build package +pnpm build + +# Run tests +pnpm test ``` -You can preview the production build with `npm run preview`. +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License + +MIT License - see the [LICENSE](LICENSE) file for details. + +## Author -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +zapaz.eth (http://labs.kredeum.com/) \ No newline at end of file diff --git a/package.json b/package.json index 447b35a..3349b74 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@kredeum/wagmi-svelte5", - "version": "0.1.3", + "version": "0.1.4", "description": "Svelte5 Web3 library based on Wagmi", "keywords": [ "svelte", @@ -11,7 +11,7 @@ ], "homepage": "https://github.com/zapaz/wagmi-svelte5", "license": "MIT", - "author": "zapaz.eth (http://labs.kredeum.com/)", + "author": "zapaz.eth (http://labs.kredeum.com/)", "files": [ "dist" ],