Skip to content

Commit

Permalink
docs: add install step via homebrew
Browse files Browse the repository at this point in the history
  • Loading branch information
orestesgaolin committed Oct 15, 2024
1 parent d851ae9 commit 558fb4a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
13 changes: 12 additions & 1 deletion changelog_cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ By default it just generates the changelog based on the whole git history. You c

---

## Getting Started 🚀
## Installation

### Pub.dev

If the CLI application is available on [pub](https://pub.dev), activate globally via:

Expand All @@ -22,6 +24,15 @@ Or locally via:
dart pub global activate --source=path <path to this package>
```

### Homebrew

You can install the CLI via Homebrew:

```sh
brew tap orestesgaolin/tap
brew install changelog_cli
```

## Usage

```sh
Expand Down
13 changes: 12 additions & 1 deletion slack_cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ Supported commands:
- `post` - sends a message to Slack channel
- `update` - updates the CLI

## Getting Started 🚀
## Installation

### Pub.dev

Activate globally from pub.dev via:

Expand All @@ -27,6 +29,15 @@ Or locally via:
dart pub global activate --source=path <path to this package>
```

### Homebrew

You can install the CLI via Homebrew:

```sh
brew tap orestesgaolin/tap
brew install slack_cli
```

## Posting messages

The `post` command allows to send messages to desired Slack channel. Before you use this CLI, you need to create Slack app and get bot token. See [this official manual](https://api.slack.com/quickstart) for more details. Once you have the token (it starts with `xoxb-`), you can use it to send messages to Slack channels.
Expand Down

0 comments on commit 558fb4a

Please sign in to comment.