From 9155064bde1954fb6f22220864eb3da5aa2d6c57 Mon Sep 17 00:00:00 2001 From: Davide Segullo Date: Wed, 8 Nov 2023 15:15:15 +0100 Subject: [PATCH] docs: :memo: update readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 3deec1dd..b1412dca 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,32 @@ ![IBC tx track FSM](https://github.com/nabla-studio/quirks/blob/main/docs/one-for-all.webp) +Quirks is a library to easily connect your dapp with existing wallets in the Cosmos blockchain ecosystem. + +## 🪄 Features + +- 🔀 Cross Framework +- ⚙️ React and NextJS support +- ⚙️ Vue and NuxtJS support +- 📉 Small bundles, with vendor chunk splitting +- 💳 Different wallet supports (Keplr and Leap) +- 💪 Fully typed and tree-shakeable +- 🌍 Global state even outside the frameworks + +And many more to come: + +- [ ] React Native Support +- [ ] Wallet Connect Support +- [ ] Web3 Modal Support +- [ ] UI Kit (Cross Framework) +- [ ] Improve Docs + +## 📚 Examples + +- [NuxtJS](https://github.com/nabla-studio/quirks-nuxt-example) +- [NextJS](https://github.com/nabla-studio/quirks/tree/main/examples/nextjs) +- [Vue 3](https://github.com/nabla-studio/quirks/tree/main/examples/vue3) + ## 🔧 Installation Node.js is required to run the project.