0.2.1: (feat) Update readme + add types

README.md

@@ -1,18 +1,50 @@
+# Eth Chains
+Helper module for getting Ethereum chains info from [chainid.network](https://chainid.network/).
 
-### Usage
-```js
-import chains, { ChainId, ChainName } from 'eth-chains'
+## Install
+```
+yarn add eth-chains
+```
 
-chains.getById(ChainId.EthereumMainnet) // returns Ethereum Mainnet object
-chains.getByName(ChainName.EthereumMainnet)
-chains.get() // pass in a networkId or a networkName
+```
+npm install eth-chains
+```
 
+## Usage
+Import `chains` methods and enums:
+```ts
+import chains, { ChainId, ChainName } from 'eth-chains'
+```
+### Chain names and ids via Enums:
+```ts
 console.log(ChainId.EthereumMainnet) // 1
 console.log(ChainId.BinanceSmartChainMainnet) // 56
-
 console.log(ChainName.EthereumMainnet) // "Ethereum Mainnet"
 ```
 
+### Chain by ID:
+```ts
+chains.getById(ChainId.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
+// Equivalent
+chains.getById(1) 
+```
+
+### Chain by Name:
+```ts
+chains.getByName(ChainName.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
+// Equivalent
+chains.getByName('Ethereum Mainnet')
+```
+
+### Typescript Types:
+```ts
+import { Chain, NativeCurrency, Explorer } from 'eth-chains'
+const ethereum: Chain = chains.getById(ChainId.EthereumMainnet)
+ethereum.chain // 'ETH'
+```
+
+---
+
 TODO:
 - [ ] Add webhook that watches the chains repo and triggers an update to this package whenever that repo gets updated
     - [ ] Add check in the deploy script to make sure that the types are correct before publishing

index.ts

@@ -1 +1 @@
-export {default as chains} from './src'
+export {default as chains, Chain, ChainId, ChainName, NativeCurrency, Explorer } from './src'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eth-chains",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Helper module for getting Ethereum chains info.",
   "main": "index.ts",
   "author": "Taylor Dawson",

src/index.ts

@@ -1,8 +1,8 @@
 import { Chain } from './types'
 import { chains } from './chains'
-
+export { NativeCurrency, Explorer } from './types'
 export { ChainName, ChainId } from './enums'
-export { chains }
+export { chains, Chain }
 
 const getById = (id: number): Chain | undefined => chains[id]