Skip to content

Commit b14fb6e

Browse files
authored
Merge pull request #1 from daniissac/agent/visibility-upgrade
Improve project presentation and safety guidance
2 parents 43b365a + 76fcb63 commit b14fb6e

5 files changed

Lines changed: 72 additions & 0 deletions

File tree

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,8 @@ package-lock.json
4545
*.json
4646
*.log
4747
exports/
48+
49+
# Versioned documentation assets
50+
!docs/
51+
!docs/social-preview.png
52+
!docs/topology-example.svg

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Dani Issac
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ A lightweight subnet audit tool. Scan a network, see what's alive, diff changes,
44

55
[![PyPI](https://img.shields.io/pypi/v/whoson)](https://pypi.org/project/whoson/)
66
[![CI](https://github.com/daniissac/whoson/actions/workflows/ci.yml/badge.svg)](https://github.com/daniissac/whoson/actions/workflows/ci.yml)
7+
[![Python](https://img.shields.io/pypi/pyversions/whoson)](https://pypi.org/project/whoson/)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
79

10+
[![Example whoson network topology](docs/topology-example.svg)](docs/topology-example.svg)
11+
12+
> [!IMPORTANT]
13+
> Scan only networks you own or are explicitly authorized to assess.
814
915
## Install
1016

@@ -186,3 +192,11 @@ cd whoson
186192
pip install -e ".[dev]"
187193
pytest
188194
```
195+
196+
## Contributing
197+
198+
Issues and focused pull requests are welcome. Please include tests for behavioral changes and run `pytest` before submitting a pull request.
199+
200+
## License
201+
202+
[MIT](LICENSE)

docs/social-preview.png

34.1 KB
Loading

docs/topology-example.svg

Lines changed: 32 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)