From 457e8e280fbeea477ecfa1f13809f26cc3535375 Mon Sep 17 00:00:00 2001 From: Bence Haromi <56651250+benceharomi@users.noreply.github.com> Date: Thu, 29 Aug 2024 16:49:17 +0100 Subject: [PATCH] docs: readme fixes (#34) * docs(readme): remapping path fix * docs(readme): logo full url added * docs(readme): beta version specified in install examples * docs(readme): logo updated --- README.md | 8 ++++---- logo.svg | 26 +++++++++++++++++--------- 2 files changed, 21 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9133c03..674e08e 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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 diff --git a/logo.svg b/logo.svg index 1e28358..390157c 100644 --- a/logo.svg +++ b/logo.svg @@ -1,10 +1,18 @@ - - - - - - - - - + + + + + + + + + + + + + + + + +