Add screenshot, fix module path

This commit is contained in:
Łukasz Moskała 2024-01-24 21:35:46 +01:00
parent c17cace17c
commit 6642554473
4 changed files with 16 additions and 2 deletions

1
.gitignore vendored
View file

@ -1,5 +1,6 @@
.* .*
!.gitignore !.gitignore
!.screenshot.png
minipam minipam
*.yaml *.yaml
*.json *.json

BIN
.screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

View file

@ -11,7 +11,20 @@ there is no authorization mechanism built in.
Scanning is kind of slow, but I prefer to keep it that way, since I don't need it to be fast, and I don't want to waste Scanning is kind of slow, but I prefer to keep it that way, since I don't need it to be fast, and I don't want to waste
my compute resources. It doesn't matter for me if my scan completes within 1 minute or within 30 minutes. my compute resources. It doesn't matter for me if my scan completes within 1 minute or within 30 minutes.
TODO: screenshot ![Screenshot](.screenshot.png)
# Compilation
Install go toolchain and run
```bash
go install git.mlody.eu/lmoskala/MinIPAM
```
Or, clone repository and run
```bash
go build
```
Cross-compiling is as easy as running `GOOS=freebsd GOARCH=amd64 go build`.
# Configuration reference # Configuration reference
```yaml ```yaml

2
go.mod
View file

@ -1,4 +1,4 @@
module minipam module git.mlody.eu/lmoskala/MinIPAM
go 1.21 go 1.21