From 54fe4bd947f82f9e051555f184d07ae1e825cf5b Mon Sep 17 00:00:00 2001 From: Igor Petkovic Date: Thu, 13 Apr 2023 11:50:41 +0200 Subject: [PATCH] [docs] update readme intro (#66) * fix: remove .DS_Store * chore: update .gitignore * docs: update readme intro --- .DS_Store | Bin 6148 -> 0 bytes .changeset/swift-kids-bake.md | 5 +++++ .gitignore | 4 ++-- README.md | 6 +++++- 4 files changed, 12 insertions(+), 3 deletions(-) delete mode 100644 .DS_Store create mode 100644 .changeset/swift-kids-bake.md diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 879bd63f75ab25cdf263f31bfa330555c8265614..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKF;2ul47A}SPNLvS%KZXAh)zdA%?G&T5CxHfgy_@pY?xV_6VZZ1MFC^Uo~+li zn@kb!nwf834p(LyGh4%n_R7#2=jn}|WQOQ17t*t&h4`V+~Kiv-t$fST2kOERb3jAvY(6edl^FT!@AO)nrQ33uR3Y^#_ z&VlvUfxzQC=T}4;p6gu#SaRGY&ViVLc~F5t^}J$u(2*}$*Coz@K{u~EW1ZaD^M>Me zcjQYgH}3)!rGOMzDsURZ4g3E!{G0p#lBAIokOF^70blKIcUyc?_SWX(*lP>?4*p@N mt>p-dLjVSB#h0Jz3ZGHeCC-7Bj(nv9br7H~GAZyI3cLg9o+6h3 diff --git a/.changeset/swift-kids-bake.md b/.changeset/swift-kids-bake.md new file mode 100644 index 0000000..1de86e9 --- /dev/null +++ b/.changeset/swift-kids-bake.md @@ -0,0 +1,5 @@ +--- +"@tenderly/sdk": patch +--- + +[docs] update readme intro diff --git a/.gitignore b/.gitignore index a864281..4021a27 100644 --- a/.gitignore +++ b/.gitignore @@ -5,11 +5,11 @@ coverage .vscode .env +.DS_Store *.output.json *.output.txt - .pnp.* .yarn/* !.yarn/patches @@ -18,4 +18,4 @@ coverage !.yarn/sdks !.yarn/versions -*.tgz \ No newline at end of file +*.tgz diff --git a/README.md b/README.md index 354331a..f3b9420 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ SDK for working with your favorite Web3 development platform ## Introduction +The Tenderly SDK provides an easy-to-use interface for interacting with the Tenderly platform. + +It allows you to simulate transactions, simulate transaction bundles, manage contracts and wallets, and verify smart contracts from your code. The SDK is particularly useful for blockchain developers who want to integrate Tenderly's powerful tools into their dapp or development workflow. + List of supported networks can be found here ## Documentation @@ -68,7 +72,7 @@ pnpm add @tenderly/sdk ### Quick start -Instantiate a new tenderly instance with your project details. _We highly recommend using environment variables for sensitive data such as access keys durring your local development!_ +Instantiate a new tenderly instance with your project details. _We highly recommend using environment variables for sensitive data such as access keys during your local development!_ ```ts import { Tenderly, Network } from '@tenderly/sdk';