https://github.com/pooltogether/generate-networks-doc

Tool to update docs.pooltogether.com/networks
https://github.com/pooltogether/generate-networks-doc

Last synced: about 2 months ago
JSON representation

Tool to update docs.pooltogether.com/networks

• Host: GitHub
• URL: https://github.com/pooltogether/generate-networks-doc
• Owner: pooltogether
• Created: 2020-10-07T22:51:35.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-31T17:41:41.000Z (over 3 years ago)
• Last Synced: 2024-04-23T21:42:35.802Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 3.99 MB
• Stars: 2
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Generate Networks documentation

This project generates a Markdown formatted page including all of the network information for PoolTogether.

# Usage

To generate markdown file `Networks.md` call:

```sh

$ yarn generate

```

To generate the markdown file and push changes to Gitbook (https://docs.pooltogether.com):

```sh

$ yarn generate-and-push

```

To update the Pools, artifacts and addresses just update the dependencies in `package.json`:

```json

{

  // ...

  "dependencies": {

      "@pooltogether/current-pool-data": "^3.0.0-alpha.40",

      "@pooltogether/pooltogether-contracts": "^3.0.0-alpha.41",

  }

}

```

# Setup

```sh

$ yarn

```