Skip to content

docs: update installation section with Hub commands #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heavybeard merged 1 commit into from
Apr 26, 2026
Merged

docs: update installation section with Hub commands #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,21 +45,27 @@ To remove a package, simply delete the corresponding `.yml` file from the Espans

## Installation

> **Espanso Hub support coming soon.** Once approved, a single `espanso install refuos-italiano` will be enough. In the meantime, the commands below work identically.

1. Install [Espanso](https://espanso.org) from its website
2. Run:

```bash
espanso install refuos-italiano --git https://github.com/heavybeard/refuos --git-branch pkg/refuos-italiano --external
espanso install refuos-accenti --git https://github.com/heavybeard/refuos --git-branch pkg/refuos-accenti --external
espanso install refuos-dev --git https://github.com/heavybeard/refuos --git-branch pkg/refuos-dev --external
espanso install refuos-italiano
espanso install refuos-accenti
espanso install refuos-dev
```

3. Restart Espanso if it doesn't pick up the new rules automatically.

To install only specific packages, just run the corresponding command above.

> **Alternative (while Hub approval is pending):** use the `--git` flag pointing directly to this repo:
>
> ```bash
> espanso install refuos-italiano --git https://github.com/heavybeard/refuos --git-branch pkg/refuos-italiano --external
> espanso install refuos-accenti --git https://github.com/heavybeard/refuos --git-branch pkg/refuos-accenti --external
> espanso install refuos-dev --git https://github.com/heavybeard/refuos --git-branch pkg/refuos-dev --external
> ```

For alternative methods (ZIP download, one-liner scripts for macOS, Linux and Windows) see [INSTALL.md](INSTALL.md).

## Adding words
Expand Down
Loading