Skip to content

Commit d3ac520

Browse files
docs: update README.md for CLI accuracy and standards
- Replace hardcoded version with <version> placeholder in installation script - Link to GitHub Releases page in manual installation instructions - Remove unnecessary blank lines in code fences - Ensure alignment with project documentation standards Co-authored-by: yacosta738 <33158051+yacosta738@users.noreply.github.com>
1 parent b202ac1 commit d3ac520

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,12 @@ cargo install agentsync
102102

103103
### From GitHub Releases (Pre-built Binaries)
104104

105-
Download the latest release for your platform from the [GitHub Releases](https://github.com/dallay/agentsync/releases) page.
106-
107-
To install via terminal, you can use the following script (replace `VERSION` with the latest version number, e.g., `1.28.0`):
105+
For manual installation, visit the [GitHub Releases](https://github.com/dallay/agentsync/releases) page to find the latest version. Substitute `<version>` with a real tag (e.g., `1.28.0`) and `<platform>` with your target in the following script:
108106

109107
```bash
110108
# Define version and platform
111-
VERSION="1.28.0"
112-
PLATFORM="x86_64-apple-darwin" # e.g., aarch64-apple-darwin, x86_64-unknown-linux-gnu
109+
VERSION="<version>"
110+
PLATFORM="<platform>" # e.g., x86_64-apple-darwin, aarch64-apple-darwin, x86_64-unknown-linux-gnu
113111
TARBALL="agentsync-${VERSION}-${PLATFORM}.tar.gz"
114112

115113
# Download binary and checksum
@@ -147,9 +145,7 @@ Or clone and build manually:
147145
git clone https://github.com/dallay/agentsync
148146
cd agentsync
149147
cargo build --release
150-
151148
# The binary will be available at ./target/release/agentsync
152-
153149
```
154150

155151
## Quick Start

0 commit comments

Comments
 (0)