docs: add Requirements and License block on README.md
All checks were successful
CI.yml / build (push) Successful in 48s
All checks were successful
CI.yml / build (push) Successful in 48s
This commit is contained in:
15
README.md
15
README.md
@@ -1,6 +1,6 @@
|
|||||||
# BanForge
|
# BanForge
|
||||||
|
|
||||||
Log-based IPS system written in Go for Linux based system.
|
Log-based IPS system written on Go for Linux based system.
|
||||||
|
|
||||||
# Table of contents
|
# Table of contents
|
||||||
1. [Overview](#overview)
|
1. [Overview](#overview)
|
||||||
@@ -20,3 +20,16 @@ If you have any questions or suggestions, create issue on [Github](https://githu
|
|||||||
- [ ] Add support for other service
|
- [ ] Add support for other service
|
||||||
- [ ] Add support for user service with regular expressions
|
- [ ] Add support for user service with regular expressions
|
||||||
- [ ] TUI interface
|
- [ ] TUI interface
|
||||||
|
|
||||||
|
# Requirements
|
||||||
|
|
||||||
|
- Go 1.21+
|
||||||
|
- ufw/iptables/nftables/firewalld
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
currently no binary file if you wanna build the project yourself, you can use [Makefile](https://github.com/d3m0k1d/BanForge/blob/master/Makefile)
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
# License
|
||||||
|
The project is licensed under the [GPL-3.0](https://github.com/d3m0k1d/BanForge/blob/master/LICENSE)
|
||||||
|
|||||||
Reference in New Issue
Block a user