ObNitram/git-release
1
0
Fork 0
mirror of https://github.com/ObNitram/git-release.git synced 2026-03-22 03:42:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README to improve section headings and clarify installation instructions

Browse Source
This commit is contained in:
ObNitram
2025-10-29 14:54:38 +01:00
parent c1aa7c9412
commit 2e507d50e7
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -2,7 +2,7 @@
Minimal tool to create and publish Git release tags following the vX.Y.Z format. Minimal tool to create and publish Git release tags following the vX.Y.Z format.
Usage ## Usage
- From the repository root: `./git-release` - From the repository root: `./git-release`
- The script creates an annotated tag and pushes it to the configured remote. - The script creates an annotated tag and pushes it to the configured remote.
- If the script is in your PATH, you can run it directly with `git release` - If the script is in your PATH, you can run it directly with `git release`
@@ -31,13 +31,14 @@ $ git release
✅ Release v0.1.0 created and pushed successfully! ✅ Release v0.1.0 created and pushed successfully!
``` ```
Installation ## Installation
- Make the script executable: `chmod +x git-release` - Make the script executable: `chmod +x git-release`
- (Optional) Copy to PATH: `cp git-release $HOME/.local/bin/git-release` - (Optional) Create a hard link in your PATH :
`ln "$(pwd)/git-release" "$HOME/.local/bin/git-release"`
Dependencies ## Dependencies
- git - git
License ## License
- See the repository `LICENSE` file. - See the repository `LICENSE` file.