Skip to content

Commit

Permalink
docs: readme fixes (#34)
Browse files Browse the repository at this point in the history
* docs(readme): remapping path fix

* docs(readme): logo full url added

* docs(readme): beta version specified in install examples

* docs(readme): logo updated
  • Loading branch information
benceharomi authored Aug 29, 2024
1 parent 1722490 commit 457e8e2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 13 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ZKsync Contracts

[![Logo](logo.svg)](https://zksync.io)
[![Logo](https://raw.githubusercontent.com/matter-labs/v2-testnet-contracts/main/logo.svg)](https://zksync.io)

This package contains ZKsync L1, L2 and System Contracts. For more details see the [source repository](https://github.com/matter-labs/era-contracts).

Expand All @@ -9,19 +9,19 @@ This package contains ZKsync L1, L2 and System Contracts. For more details see t
### Hardhat

```bash
yarn add @matterlabs/zksync-contracts
yarn add @matterlabs/zksync-contracts@1.0.0-beta.1
```

### Foundry

```bash
forge install matter-labs/v2-testnet-contracts
forge install matter-labs/v2-testnet-contracts@1.0.0-beta.1
```

Add the following to the `remappings.txt` file of your project:

```txt
@matterlabs/zksync-contracts/=/lib/v2-testnet-contracts/
@matterlabs/zksync-contracts/=lib/v2-testnet-contracts/
```

## Usage
Expand Down
26 changes: 17 additions & 9 deletions logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 457e8e2

Please sign in to comment.