-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README [skip ci] Our readme for transaction kit was terribly out of date. I've updated it to be in line with Skandha and Arka, and to include all updated information. * Update README.md [skip ci] Fix error * fix typo [skip ci] Co-authored-by: I Am Kio <[email protected]> --------- Co-authored-by: I Am Kio <[email protected]>
- Loading branch information
1 parent
d722243
commit f77c475
Showing
1 changed file
with
52 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,70 @@ | ||
| # ✨ TransactionKit | ||
| <div align="center"> | ||
| <h1 align="center">TransactionKit</h1> | ||
| </div> | ||
|
|
||
| [](https://github.com/etherspot/transaction-kit/LICENSE) | ||
| [](https://www.npmjs.com/package/@etherspot/transaction-kit) | ||
| [](https://github.com/etherspot/transaction-kit/graphs/contributors) | ||
| [](https://discord.etherspot.io) | ||
| <div align="center"> | ||
| <img src="https://public.etherspot.io/assets/etherspot.gif" width="200" height="200"> | ||
| <p> | ||
| <b> | ||
| TransactionKit is a collection of headless React Components that take the pain out of web3 development. | ||
| </b> | ||
| </p> | ||
| </div> | ||
|
|
||
| #### TransactionKit is a collection of headless React Components that take the pain out of Web3 development. Here are just some of the features of TransactionKit: | ||
| -------------- | ||
|
|
||
| #### 👉 Supports 13 chains and their testnets | ||
| You read that right. TransactionKit is built on top of Etherspot and helps make your app truly multichain. TransactionKit supports Ethereum, Polygon, Gnosis, Binance, Fantom, Aurora, Avalanche, Optimism, Arbitrum, Moonbeam, Celo, Fuse and Arbitrum Nova. | ||
| >[!IMPORTANT] | ||
| >This repo/software is under active development. | ||
| > | ||
| >[](https://www.npmjs.com/package/@etherspot/transaction-kit) | ||
| #### 👉 Transaction Batching out the box | ||
| Organise your transactions into batches to have them execute together. Each batch can be performed on a different blockchain. | ||
|
|
||
| #### 👉 Zero configuration | ||
| You bring the code and we'll handle the infrastructure. Built with your productivity and speed in mind. No need to configure infrastructure providers, no signups needed. Just install the code and start sending transactions. | ||
| ## 🧰 TransactionKit | ||
|
|
||
| #### 👉 Total design freedom | ||
| TransactionKit is a headless collection of React Components and does not impose any existing user interfaces on you. You design and build how you envision your app, and we'll handle all the technical complexity. | ||
| TransactionKit is a React Library which let's devs, no matter how experienced get going with web3 development with ease. | ||
|
|
||
| ## Sounds good? I thought so. Lets install | ||
| ``` | ||
| It simplifies working with Account Abstraction so developers can focus on building a great User Experience and easily interact with their Smart Contracts | ||
| on a [large number of EVM based chains](https://etherspot.fyi/prime-sdk/chains-supported). | ||
|
|
||
| ## ⚙ Get started | ||
|
|
||
| You can either get started by installing the packages yourself here: | ||
|
|
||
| ```bash | ||
| npm i @etherspot/transaction-kit | ||
| ``` | ||
|
|
||
| ## Documentation | ||
| Please head over to our [documentation](https://docs.etherspot.dev/transaction-kit/introduction) to [get started quickly](https://docs.etherspot.dev/transaction-kit/quick-start). | ||
| Or follow our introductory guide on our docs [here](https://etherspot.fyi/transaction-kit/introduction-to-transaction-kit) which walk you through | ||
| cloning down an example repo and setting up a dapp in your own environment. | ||
|
|
||
| ## 📖 Documentation | ||
|
|
||
| Here's a list of quick jumps to the documentation: | ||
| - [Quick Start](https://docs.etherspot.dev/transaction-kit/quick-start) | ||
| - [Quick Start](https://etherspot.fyi/transaction-kit/introduction-to-transaction-kit) | ||
| - [Send Native Token](https://etherspot.fyi/transaction-kit/send-native-token) | ||
| - [React Hooks](https://docs.etherspot.dev/transaction-kit/react-hooks) | ||
| - [React Components](https://docs.etherspot.dev/transaction-kit/react-components) | ||
|
|
||
| ## Contributions | ||
| ## 🔗 Important Links | ||
|
|
||
| - [Business site](https://etherspot.io/transactionkit/) | ||
| - [Send Native Token Code](https://codesandbox.io/s/etherspot-prime-send-native-token-demo-j2h44g) | ||
| - [Staking Example](https://codesandbox.io/p/sandbox/etherspot-prime-staking-tutorial-q2m4dw) | ||
|
|
||
| Follow [guide](./CONTRIBUTING.md) | ||
| ## 🏌️♂️ Contributions | ||
|
|
||
| ## Security | ||
| Follow [this guide](./CONTRIBUTING.md) to learn how to contribute to this repo. | ||
|
|
||
| ## 🔐 Security | ||
|
|
||
| To report security issues please follow [guide](./SECURITY.md) | ||
| ## License | ||
| [MIT](./LICENSE) | ||
|
|
||
| ## 💬 Contact | ||
|
|
||
| If you have any questions or feedback about TransactionKit, please feel free to reach out to us. | ||
|
|
||
| - [Follow on Twitter](https://twitter.com/etherspot) | ||
| - [Join our discord](https://discord.etherspot.io/) | ||
|
|
||
| ## 📄 License | ||
|
|
||
| Licensed under the [MIT License](https://github.com/etherspot/transaction-kit/blob/master/LICENSE). |