Skip to content

docs: README with pointer to unified install guide - #2

Merged
kuyacarlo merged 1 commit into
mainfrom
overnight/ssh-profile-install-doc-link
Aug 15, 2026
Merged

kuyacarlo merged 1 commit into
mainfrom
overnight/ssh-profile-install-doc-link

Conversation

@kuyacarlo

@kuyacarlo kuyacarlo commented Aug 10, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Add a README for git-ssh (this repo had none).
  • Short install summary + command table from existing CLI/install.sh/Copr/release paths.
  • Points to the canonical paired install doc: git-profile docs/INSTALL.md.

Dependencies — lands after git-profile#1

This PR links to https://github.com/kuyacarlo/git-profile/blob/master/docs/INSTALL.md, which only resolves after git-profile PR #1 merges. Merge git-profile#1 first, then this PR. Branch preview: overnight/git-profile-install-doc.

Test plan

  • make build → git-ssh version
  • Links to releases, install.sh, Copr, CI badge URL return HTTP 200
  • README command table verified against built CLI (git-ssh --help + each subcommand)
  • After git-profile install-doc PR merges, master docs/INSTALL.md link resolves

Closes #5

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@kuyacarlo
kuyacarlo marked this pull request as ready for review August 15, 2026 23:47
@kuyacarlo
kuyacarlo merged commit ac42246 into main Aug 15, 2026
1 check passed
@kuyacarlo
kuyacarlo deleted the overnight/ssh-profile-install-doc-link branch August 15, 2026 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: land paired install-doc stack (git-profile#1 + ssh-profile#2)

1 participant