Skip to content

Commit 62465f2

Browse files
committed
docs: update README - repo URL srex-dev/Guardian-Agent, binary guardian-server, Support links
1 parent 8590061 commit 62465f2

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -102,23 +102,23 @@ Guardian Agent is a **safety coprocessor** — a lightweight runtime that sits b
102102

103103
```bash
104104
# Clone the repository
105-
git clone https://github.com/yourusername/GuardianAgent.git
106-
cd GuardianAgent
105+
git clone https://github.com/srex-dev/Guardian-Agent.git
106+
cd Guardian-Agent
107107

108108
# Build (takes ~1 minute first time)
109109
cargo build --release --features server
110110

111-
# Binary is ready: target/release/guardian (or .exe on Windows)
111+
# Binary is ready: target/release/guardian-server (or guardian-server.exe on Windows)
112112
```
113113

114114
### Run
115115

116116
```bash
117117
# Run the server
118-
./target/release/guardian
118+
./target/release/guardian-server
119119

120120
# Or with configuration
121-
GUARDIAN_CONFIG=guardian.yaml PORT=8080 ./target/release/guardian
121+
GUARDIAN_CONFIG=guardian.yaml PORT=8080 ./target/release/guardian-server
122122
```
123123

124124
### Test
@@ -814,7 +814,7 @@ cargo test
814814

815815
```bash
816816
# Start server
817-
./target/release/guardian &
817+
./target/release/guardian-server &
818818
819819
# Test endpoints
820820
curl http://localhost:8080/health
@@ -840,7 +840,7 @@ wrk -t12 -c400 -d30s http://localhost:8080/health
840840
netstat -an | grep 8080
841841
842842
# Check logs
843-
RUST_LOG=debug ./target/release/guardian
843+
RUST_LOG=debug ./target/release/guardian-server
844844
```
845845

846846
### OPA Not Found
@@ -873,7 +873,7 @@ ls -la policies/
873873
cat guardian.yaml
874874
875875
# Enable debug logging
876-
RUST_LOG=debug ./target/release/guardian
876+
RUST_LOG=debug ./target/release/guardian-server
877877
```
878878

879879
## 📚 Advanced Usage
@@ -1181,7 +1181,7 @@ Logs are written in JSONL format with cryptographic signatures:
11811181
1. **Port already in use**
11821182
```bash
11831183
# Use different port
1184-
PORT=8081 ./target/release/guardian
1184+
PORT=8081 ./target/release/guardian-server
11851185
```
11861186

11871187
2. **Policy not found**
@@ -1199,7 +1199,7 @@ Logs are written in JSONL format with cryptographic signatures:
11991199
4. **Permission denied**
12001200
```bash
12011201
# Check file permissions
1202-
chmod +x target/release/guardian
1202+
chmod +x target/release/guardian-server
12031203
```
12041204

12051205
## 🤝 Contributing
@@ -1219,9 +1219,9 @@ MIT License - see [LICENSE](LICENSE) for details.
12191219

12201220
## 📞 Support
12211221

1222-
- **Documentation**: This README
1223-
- **Issues**: GitHub Issues
1224-
- **Discussions**: GitHub Discussions
1222+
- **Documentation**: This README and [docs/](docs/)
1223+
- **Issues**: [GitHub Issues](https://github.com/srex-dev/Guardian-Agent/issues)
1224+
- **Discussions**: [GitHub Discussions](https://github.com/srex-dev/Guardian-Agent/discussions)
12251225

12261226
---
12271227

0 commit comments

Comments
 (0)