diff --git a/README.md b/README.md index 6aaa813c8..8729c8a6b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,56 @@ -
+ +
+ Synpress is a powerful and developer-friendly E2E testing library for Web3 dapps, built on top of Cypress and Playwright. It simplifies testing interactions with wallets like MetaMask and other blockchain-specific operations. +
+ + + + +## ✨ Features + +- **Playwright and Cypress Support**: Use either Playwright or Cypress as your testing framework, leveraging all their existing features and functionalities with Synpress. +- **One-Time Browser Setup & Caching:** Define your dApps wallet setup once, and let Synpress cache the browser state. This dramatically speeds up test execution and unlocks the full potential of Playwright and Cypress, including parallel testing. +- **Built-in Wallet and Blockchain Agnostic System**: Synpress core is designed to be wallet and blockchain agnostic, offering flexibility for future integrations and broader dApp support. +- **MetaMask Integration**: Deep integration with MetaMask for seamless testing of common dApp interactions. +- **TypeScript Support**: Enhanced TypeScript support for improved type safety and developer experience. +- **Anvil Support**: Easily spin up a local Anvil node with just one line of code for fast and isolated testing. +- **Blazing Fast Performance**: Synpress is optimized for speed, rivalling native Web2 testing framework performance. +- **Improved Debugging**: Detailed error handling, combined with the debugging tools of Playwright and Cypress, makes pinpointing and resolving issues simple. + +## 🧑💻 Installation + +```bash +pnpm add -D @synthetixio/synpress@latest +``` + +## 📝 Documentation + +For comprehensive guides, API references, and examples, refer to our [official documentation](https://synpress.io/docs/getting-started). + +## 🧑🤝🧑 Community + +Join our vibrant community for support, discussions, and updates: + +- [Discord](https://discord.gg/XhZKSRGtWc) +- [X (formerly Twitter)](https://twitter.com/Synpress_) diff --git a/docs/public/demo.gif b/docs/public/demo.gif new file mode 100644 index 000000000..23da06bf9 Binary files /dev/null and b/docs/public/demo.gif differ diff --git a/docs/public/optimism-logo.png b/docs/public/optimism-logo.png new file mode 100644 index 000000000..0d5369d66 Binary files /dev/null and b/docs/public/optimism-logo.png differ