Skip to content

Commit 6ab66c1

Browse files
committed
updated README
1 parent d2c29f0 commit 6ab66c1

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# RIP
22
A simple DNS server that extracts IP address from the requested domain name and sends it back in the response.
33

4-
# Encoding rules
4+
# Usage
5+
6+
0. Install Go 1.16+
7+
1. Perform `go get -u github.com/buglloc/rip/v2`
8+
2. Have fun ;)
9+
10+
## Encoding rules
511
Since RIP extracts the response from the request, it's important to understand the encoding rules.
612
RIP has three kinds of entities:
713
- rr - something that generate response (e.g. IP, CNAME and so on):
@@ -28,15 +34,15 @@ RIP has three kinds of entities:
2834

2935
Also, RIP allowing to use any prefixes (see examples below).
3036

31-
# IP address format
37+
## IP address format
3238
IP address can be presented in two variants - dash-delimited and base16-form. For example, ips `0a000001` and `10-0-0-1` are equal and points to `10.0.0.1`
3339
You can also use the built-in converter to encode IP address:
3440
```
3541
$ rip encode fe80::fa94:c2ff:fee5:3cf6 127.0.0.1
3642
fe80000000000000fa94c2fffee53cf6 7f000001
3743
```
3844

39-
# Usage
45+
## Examples
4046
Run NS server for zone `example.com` with default IP `77.88.55.70` and `2a02:6b8: a:: a`:
4147
```
4248
$ rip ns --zone=example.com --ipv4=77.88.55.70 --ipv6=2a02:6b8:a::a

0 commit comments

Comments
 (0)