Skip to content

Commit 97492e7

Browse files
authored
Merge pull request #4 from swaQQii/docs/update-readme
docs(readme): update badges and add contributing/security sections
2 parents 53d0ec6 + adbc563 commit 97492e7

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
[![Website](https://img.shields.io/badge/Website-coredocs.eu-9146FF?style=for-the-badge&logo=google-chrome&logoColor=white)](https://coredocs.eu)
2-
32
[![Lint](https://img.shields.io/github/actions/workflow/status/swaQQii/coredocs-netbox-scripts/lint.yml?style=for-the-badge&label=Lint%20CI&logo=github)](https://github.com/swaQQii/coredocs-netbox-scripts/actions/workflows/lint.yml)
43
[![Style](https://img.shields.io/github/actions/workflow/status/swaQQii/coredocs-netbox-scripts/style.yml?style=for-the-badge&label=Style%20CI&logo=github)](https://github.com/swaQQii/coredocs-netbox-scripts/actions/workflows/style.yml)
5-
64
[![Last Commit](https://img.shields.io/github/last-commit/swaQQii/coredocs-netbox-scripts?style=for-the-badge)](https://github.com/swaQQii/coredocs-netbox-scripts/commits/main)
75

86
[![Made with Python](https://img.shields.io/badge/Made%20with-Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
97
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](LICENSE)
108

9+
[![GitHub issues](https://img.shields.io/github/issues/swaQQii/coredocs-netbox-scripts?style=for-the-badge)](https://github.com/swaQQii/coredocs-netbox-scripts/issues)
10+
[![GitHub pull requests](https://img.shields.io/github/issues-pr/swaQQii/coredocs-netbox-scripts?style=for-the-badge)](https://github.com/swaQQii/coredocs-netbox-scripts/pulls)
11+
1112
# coredocs-netbox-scripts
1213

1314
Collection of reusable **NetBox Custom Scripts** – automation examples for:
@@ -23,9 +24,8 @@ Collection of reusable **NetBox Custom Scripts** – automation examples for:
2324

2425
- [Getting Started](#getting-started)
2526
- [Available Scripts](#available-scripts)
26-
- [Hello Script](docs/hello_script.md)[Code](scripts/01_hello_script.py)
27-
- [Reserve IPv4 Script](docs/reserve_ipv4.md)[Code](scripts/02_reserve_ipv4.py)
28-
- [Create Site (Auto Geo)](docs/create_site_osm.md)[Code](scripts/03_create_site_osm.py)
27+
- [Contributing](#contributing)
28+
- [Security](#security)
2929
- [License](#license)
3030
- [Related](#related)
3131

@@ -46,29 +46,42 @@ Collection of reusable **NetBox Custom Scripts** – automation examples for:
4646
3. Alternatively, place them under your NetBox installation:
4747
4. Run scripts via the NetBox web interface.
4848

49-
- Toggle **Commit** off → dry run (no database changes)
50-
- Toggle **Commit** on → changes are saved
49+
- Toggle **Commit** off → dry run (no database changes)
50+
- Toggle **Commit** on → changes are saved
5151

5252
---
5353

5454
## Available Scripts
5555

56-
- **[Hello Script](docs/hello_script.md)** – Minimal example to demonstrate inputs, logging, and commit.
57-
- **[Reserve IPv4](docs/reserve_ipv4.md)** – Finds the first free IPv4 in a prefix and assigns it.
58-
- **[Create Site (Auto-Geo)](docs/create_site_osm.md)** – Creates a Site using OSM geocoding, coordinates, and timezone auto-detection.
56+
- **[Hello Script](docs/hello_script.md)** – Minimal example to demonstrate inputs, logging, and commit.
57+
- **[Reserve IPv4](docs/reserve_ipv4.md)** – Finds the first free IPv4 in a prefix and assigns it.
58+
- **[Create Site (Auto-Geo)](docs/create_site_osm.md)** – Creates a Site using OSM geocoding, coordinates, and timezone auto-detection.
59+
60+
---
61+
62+
## Contributing
63+
64+
Contributions are welcome!
65+
See the [Contributing Guidelines](CONTRIBUTING.md) before opening issues or pull requests.
66+
67+
---
68+
69+
## Security
70+
71+
If you discover a security issue, please review our [Security Policy](SECURITY.md).
5972

6073
---
6174

6275
## License
6376

6477
This project is licensed under the [MIT License](LICENSE).
65-
You are free to use, modify, and distribute these scripts with attribution.
78+
You are free to use, modify, and distribute these scripts with attribution.
6679

6780
---
6881

6982
## Related
7083

7184
These scripts are part of the **[CoreDocs](https://coredocs.eu)** knowledge base project,
72-
which provides open IT guides, tools, and documentation resources.
85+
which provides open IT guides, tools, and documentation resources.
7386

7487
[![Discord](https://img.shields.io/badge/Discord-Join-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/Y6pGPFacvp)

0 commit comments

Comments
 (0)