Skip to content

docs: update README after Espanso Hub publication#12

Merged
heavybeard merged 1 commit intomainfrom
docs/update-readme-post-hub
Apr 27, 2026
Merged

docs: update README after Espanso Hub publication#12
heavybeard merged 1 commit intomainfrom
docs/update-readme-post-hub

Conversation

@heavybeard
Copy link
Copy Markdown
Owner

What does this PR do?

Now that all three packages (refuos-italiano, refuos-accenti, refuos-dev) are live on the Espanso Hub, update the README to reflect the new status:

  • Replace the "Alternative (while Hub approval is pending)" blockquote with a Tip explaining that Hub packages may lag behind the latest release and that the --git install method is always up to date.
  • Add the Espanso Hub badge to the badge row at the top.
  • Restructure the Updating section to list the Hub as the first method and clearly distinguish it from the GitHub (--git) channel.

Checklist

Adding or removing words

  • I edited the right file in dictionaries/ (one word per line, lowercase, alphabetically sorted)
  • I ran python3 generate_espanso.py --check with no errors
  • I ran python3 generate_espanso.py --output-dir /tmp/refuos-out and verified the output looks correct
  • There are no duplicates within the file(s) I edited

Adding a new dictionary

  • I created dictionaries/<name>.txt with the word list
  • I added the generation block in generate_espanso.py
  • I updated README.md to document the new package
  • I ran python3 generate_espanso.py --check with no errors

Other changes (generator, installer, docs)

  • The generator still runs without errors: python3 generate_espanso.py --check

Related issue

N/A


PR created by an AI agent — run aa1e543e

Made with Cursor

@heavybeard heavybeard added the documentation Improvements or additions to documentation label Apr 27, 2026
@heavybeard heavybeard merged commit 38b71f1 into main Apr 27, 2026
2 checks passed
@heavybeard heavybeard deleted the docs/update-readme-post-hub branch April 27, 2026 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant