Skip to content

Commit b2c394b

Browse files
committed
Add professional enhancements: GitHub Actions CI/CD, badges, topics, and fix README links
1 parent 9d66d3e commit b2c394b

File tree

2 files changed

+60
-4
lines changed

2 files changed

+60
-4
lines changed

.github/workflows/ci.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
env:
10+
CARGO_TERM_COLOR: always
11+
12+
jobs:
13+
test:
14+
name: Test
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v3
18+
- uses: dtolnay/rust-toolchain@stable
19+
- name: Run tests
20+
run: cargo test --verbose
21+
22+
fmt:
23+
name: Format
24+
runs-on: ubuntu-latest
25+
steps:
26+
- uses: actions/checkout@v3
27+
- uses: dtolnay/rust-toolchain@stable
28+
with:
29+
components: rustfmt
30+
- name: Check formatting
31+
run: cargo fmt -- --check
32+
33+
clippy:
34+
name: Clippy
35+
runs-on: ubuntu-latest
36+
steps:
37+
- uses: actions/checkout@v3
38+
- uses: dtolnay/rust-toolchain@stable
39+
with:
40+
components: clippy
41+
- name: Run clippy
42+
run: cargo clippy -- -D warnings
43+
44+
build:
45+
name: Build
46+
runs-on: ubuntu-latest
47+
steps:
48+
- uses: actions/checkout@v3
49+
- uses: dtolnay/rust-toolchain@stable
50+
- name: Build
51+
run: cargo build --verbose --release

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Rust Network Scanner
22

3+
[![CI](https://github.com/guardsarm/rust-network-scanner/actions/workflows/ci.yml/badge.svg)](https://github.com/guardsarm/rust-network-scanner/actions/workflows/ci.yml)
4+
[![Crates.io](https://img.shields.io/crates/v/rust-network-scanner.svg)](https://crates.io/crates/rust-network-scanner)
5+
[![Documentation](https://docs.rs/rust-network-scanner/badge.svg)](https://docs.rs/rust-network-scanner)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
38
A memory-safe, asynchronous network security scanner for vulnerability assessment and network monitoring. Built with Rust and Tokio for high-performance concurrent scanning.
49

510
## Security-First Design
@@ -205,17 +210,17 @@ This tool is for authorized security testing only. The author is not responsible
205210

206211
## Related Projects
207212

208-
- [rust-secure-logger](https://github.com/your-username/rust-secure-logger) - Secure logging with cryptographic integrity
209-
- [rust-threat-detector](https://github.com/your-username/rust-threat-detector) - SIEM threat detection
210-
- [rust-crypto-utils](https://github.com/your-username/rust-crypto-utils) - Cryptographic utilities
213+
- [rust-secure-logger](https://github.com/guardsarm/rust-secure-logger) - Secure logging with cryptographic integrity
214+
- [rust-threat-detector](https://github.com/guardsarm/rust-threat-detector) - SIEM threat detection
215+
- [rust-crypto-utils](https://github.com/guardsarm/rust-crypto-utils) - Cryptographic utilities
211216

212217
## Citation
213218

214219
If you use this scanner in research or security assessments, please cite:
215220

216221
```
217222
Awunor, T.C. (2024). Rust Network Scanner: Memory-Safe Network Security Assessment.
218-
https://github.com/your-username/rust-network-scanner
223+
https://github.com/guardsarm/rust-network-scanner
219224
```
220225

221226
---

0 commit comments

Comments
 (0)