Skip to content

Commit

Permalink
[docs] update readme intro (#66)
Browse files Browse the repository at this point in the history
* fix: remove .DS_Store

* chore: update .gitignore

* docs: update readme intro
  • Loading branch information
IgorPetkovic authored Apr 13, 2023
1 parent f6821c2 commit 54fe4bd
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
Binary file removed .DS_Store
Binary file not shown.
5 changes: 5 additions & 0 deletions .changeset/swift-kids-bake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@tenderly/sdk": patch
---

[docs] update readme intro
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ coverage

.vscode
.env
.DS_Store

*.output.json
*.output.txt


.pnp.*
.yarn/*
!.yarn/patches
Expand All @@ -18,4 +18,4 @@ coverage
!.yarn/sdks
!.yarn/versions

*.tgz
*.tgz
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href='https://docs.tenderly.co/supported-networks-and-languages'>here</a>

## Documentation
Expand Down Expand Up @@ -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';
Expand Down

0 comments on commit 54fe4bd

Please sign in to comment.