docs: document hub aliases in README - #12
Merged
Merged
Conversation
The `eispy hub alias` feature (short names for hub URLs, stored in ~/.config/eispy/hubs.json) was fully implemented but undocumented, so it never surfaced on GitHub or the PyPI project page. Add: - a Features bullet for discoverability - a "Hub aliases (eispy hub alias)" CLI subsection covering add/ls/rm, storage + EISPY_HUBS_FILE override, supported URL schemes, and usage across connect/users/chat/search/up
The client is built with LUA_SCRIPT=ON, so source builds need Lua dev headers to match the core ABI. Add liblua5.4-dev plus the other FetchContent build deps (pcre2, miniupnpc, idn2, gettext) to the Ubuntu/Debian apt list, with a note about the ABI requirement.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the existing hub aliases feature (
eispy hub alias) in the README, which is also the PyPI long description (readme = "README.md").The feature — short names for hub URLs stored in
~/.config/eispy/hubs.json(overridable viaEISPY_HUBS_FILE) — was fully implemented and tested but never documented, so it was invisible on both GitHub and the PyPI project page. Users had no way to discover it.Changes
#### Hub aliases (eispy hub alias):add/ls/rmcommandsEISPY_HUBS_FILEoverridedchub://,nmdcs://,adc://,adcs://)connect/users/chat/search/upDocs-only change; no code or behavior changes.
Notes
PyPI descriptions are frozen per-release, so this will surface on the PyPI page with the next version upload (not on the current live
2.6.0.0page).