Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
luisgj committed Sep 20, 2024
1 parent e6ac6f2 commit df8535b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bandohq/create3-proxy/blob/main/LICENSE)
[![Build](https://github.com/bandohq/create3-proxy/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/bandohq/create3-proxy/actions/workflows/CI.yml)
[![npm version](https://img.shields.io/npm/v/create3-proxy.svg)](https://www.npmjs.com/package/create3-proxy)


A Solidity library for deploying upgradeable proxies using the CREATE3 pattern, enabling deterministic addresses across different chains without relying on nonces or code.
Expand All @@ -19,12 +20,23 @@ CREATE3 Proxy combines the power of CREATE3 for deterministic contract deploymen

## Installation

To install with Foundry:
### Install with Foundry:

```bash
forge install bandohq/create3-proxy
```

### Install with npm:

```bash
npm i create3-proxy
```
### Install with yarn:

```bash
yarn add create3-proxy
```

## Usage

To use the library in your project, follow these steps:
Expand Down

0 comments on commit df8535b

Please sign in to comment.