Skip to content

Commit

Permalink
Add note on versioning to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rkalis committed May 4, 2023
1 parent 1b25e32 commit 0f45364
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Publish](https://github.com/taylorjdawson/eth-chains/actions/workflows/main.yml/badge.svg)](https://github.com/taylorjdawson/eth-chains/actions/workflows/main.yml) ![npm](https://img.shields.io/npm/v/eth-chains?logoColor=blue)
[![Publish](https://github.com/taylorjdawson/eth-chains/actions/workflows/publish-release.yml/badge.svg)](https://github.com/taylorjdawson/eth-chains/actions/workflows/publish-release.yml/badge.svg) ![npm](https://img.shields.io/npm/v/eth-chains?logoColor=blue)

# Eth Chains

Expand All @@ -14,6 +14,10 @@ yarn add eth-chains
npm install eth-chains
```

### Note on versioning

`eth-chains` uses a weekly automated release script that updates its chain data. This release script takes breaking changes into account, so breaking changes (e.g. renamed chains) are released as a new major version, while non-breaking changes (e.g. new chains) are released as a new minor version.

## Usage

Import `chains` methods and enums:
Expand Down Expand Up @@ -60,7 +64,7 @@ chains.getByName('Ethereum Mainnet')
### Get all Chains:

```ts
const allChains = chains.all()
const allChains = chains.all()
// { 1: { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }, 2: {...}}
```

Expand Down

0 comments on commit 0f45364

Please sign in to comment.