From 9729b6c1d69a910c7694c8b1c152ffe3c83eb167 Mon Sep 17 00:00:00 2001 From: Taylor Ferran <45994626+taylorferran@users.noreply.github.com> Date: Mon, 11 Dec 2023 13:23:44 +0000 Subject: [PATCH] Update README.md [skip ci] (#87) --- README.md | 77 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 62 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 80817d55..9b262cd1 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,70 @@ -# Etherspot Prime SDK -## Account Abstraction (ERC-4337) SDK -![MIT licensed][license-image] +
+

Etherspot Prime SDK

+
- - - - +
+ +

+ + Etherspot Prime is a ERC-4337 compliant Account Abstraction SDK + +

+
-Etherspot is a blockchain development framework for EVM-compatible chains that creates direct state channel bridges to provide a seamless user experience across chains and wallets. +-------------- -With just one deposit you’re able to onboard your users to the entire multichain world. +>[!IMPORTANT] +>This repo/software is under active development. +> +>[![npm](https://img.shields.io/npm/v/@etherspot/prime-sdk)](https://www.npmjs.com/package/@etherspot/prime-sdk) -More information at [etherspot.io](https://www.etherspot.io) -## License +## 🐞 Etherspot Prime +Etherspot Prime is a fully open source SDK which let's dapp developers easily get building with Account Abstraction. -MIT +The SDK makes it incredibly easy to get up and running with Account Abstraction. From social logins to transaction batching, using an Etherspot smart wallet can give your dapp a web2 like interface to ensure the user has a seamless experience. -[npm-image]: https://badge.fury.io/js/etherspot.svg -[npm-url]: https://npmjs.org/package/etherspot -[license-image]: https://img.shields.io/badge/license-MIT-blue.svg +## βš™ Get started + +You can either get started by installing the packages yourself here: + +```bash +npm i @etherspot/prime-sdk +``` + +Or follow our introductory guide on our docs [here](https://etherspot.fyi/getting-started) which walk you through +cloning down an example repo and setting up a dapp in your own environment. + +## πŸ“– Documentation + +- [Quick Start](https://etherspot.fyi/getting-started) +- [Instantiate the SDK](https://etherspot.fyi/prime-sdk/instantiation) +- [Running SDK examples](https://etherspot.fyi/examples/intro) +- [Function List](https://etherspot.fyi/prime-sdk/function) +- [Batching Transactions](https://etherspot.fyi/prime-sdk/batching-transactions) + +## πŸ”— Important Links + +- [Skandha Bundler](https://etherspot.fyi/skandha/intro) +- [Arka Paymaster](https://etherspot.fyi/arka/intro) +- [SDK Reference](https://sdk.etherspot.io/) + +## πŸŒοΈβ€β™‚οΈ Contributions + +Please feel free to open issues or PRs to this repo. + +## πŸ” Security + +To report security issues please follow [guide](./SECURITY.md) + +## πŸ’¬ Contact + +If you have any questions or feedback about Etherspot Prime, 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/etherspot-prime-sdk/blob/master/LICENSE).