Skip to content

Commit 4e48c5b

Browse files
committed
Update README.md
1 parent 5fe4b4e commit 4e48c5b

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
11
# wireguard-allowed-ips-csharp
22

3-
A small CLI tool and library written in C# to calculate the `AllowedIPs` field
3+
A small CLI tool or library written in C# to calculate the `AllowedIPs` field
44
of a wireguard config if you want to exclude certain IP-Ranges.
55

66
Inspired by (and used for test reference):
77
https://krasovs.ky/2021/07/04/wireguard-allowed-ips.html
88

9+
## Table of contents
10+
1. [Dependencies](#dependencies)
11+
2. [Releases](#releases)
12+
3. [Usage](#usage)
13+
4. [Usage within another C# application](#usage-within-another-c-application)
14+
5. [Motivation](#motivation)
15+
6. [License](#license)
16+
917
## Dependencies
1018
This program requires [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0).
1119
Other than that it was designed to require no other dependencies.
1220

21+
## Releases
22+
Executable files are provided for all major platforms. (Because why not :>) \
23+
All files ending in `-selfcontained` do not require the `.NET 7` Runtime to be installed on the system.
24+
Though they are *massively greater in filesize* than the runtime dependent ones.
25+
1326
## Usage
1427
Upon running the program without arguments via `dotnet run` (inside the cloned repo) or via the precompiled executable,
1528
a help is displayed:
@@ -75,4 +88,7 @@ I was not able to find straightforward code which shows how to replicate the res
7588
https://krasovs.ky/2021/07/04/wireguard-allowed-ips.html \
7689
(The code is written in Go and uses the `go4.org/netipx` package internally)
7790

78-
I needed a way to compute `AllowedIPs` dynamically myself. And also within a C# application. So I decided to do some research and write a small library for exactly that purpose!
91+
I needed a way to compute `AllowedIPs` dynamically myself. And also within a C# application. So I decided to do some research and write a small library for exactly that purpose!
92+
93+
## License
94+
This project is licensed under the MIT license.

0 commit comments

Comments
 (0)