Skip to content

Commit

Permalink
Added homebrew instructions to README file to install suimon
Browse files Browse the repository at this point in the history
  • Loading branch information
bartosian committed Sep 16, 2023
1 parent 772aed0 commit 71278ff
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,29 @@ Building and installing from the source is useful if you want to customize the c
- For each network that you want to connect to, create a separate YAML file with the naming convention `suimon-<network>.yaml` and put it in the `.suimon` directory. For example, if you want to connect to the mainnet, you can create a file called `suimon-mainnet.yaml` and put it in the `.suimon` directory.
## Installation using Homebrew
For macOS users, suimon can be seamlessly installed using the Homebrew package manager. Please adhere to the subsequent steps to facilitate the installation.
1. **Tap into the Repository**
- To access the necessary formulae for the installation, you'll need to first tap into our repository:
```
brew tap bartosian/tools
```
2. **Initiate the Installation**
- With the repository tapped, proceed to install Suimon:
```
brew install suimon
```
3. **Post-installation Configuration**
- Following the installation, it's essential to set up the suimon configuration file. Detailed instructions for this setup are provided in the subsequent section of this document.
Upon completion of these steps, suimon will be configured and ready for use on your macOS system.
## Suimon Configuration Files
`Suimon` uses configuration files to manage settings and defaults for different environments and networks. The default configuration file for the Suimon tool is `suimon-testnet.yaml`, which is located in the `~/.suimon` directory. However, you can use multiple configuration files to manage settings for different networks and environments.
Expand Down

0 comments on commit 71278ff

Please sign in to comment.