Skip to content

Commit

Permalink
Merge pull request #14 from nabla-studio/DavideSegullo/docs
Browse files Browse the repository at this point in the history
docs: 📝 update readme
  • Loading branch information
DavideSegullo authored Nov 8, 2023
2 parents 045d067 + 9155064 commit 32eba3c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 32eba3c

Please sign in to comment.