Update README.md

This commit is contained in:
George 2020-09-23 19:43:45 -04:00 committed by GitHub
parent 1f68d1b213
commit 1a83ce31c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,7 +1,17 @@
# meshname # meshname
Special-use naming system for self-organized IPv6 mesh networks. A universal naming system for all IPv6-based mesh networks, including CJDNS and Yggdrasil.
Implements [Meshname protocol](https://github.com/zhoreeq/meshname/blob/master/protocol.md). Implements the [Meshname protocol](https://github.com/zhoreeq/meshname/blob/master/protocol.md).
## F.A.Q.
- Q: *Is it like a decentralized DNS thing?*
- A: Yeah, sort of. With it you can host your own meshname domains and resolve domains of others.
- Q: *Meshname domains are ugly.*
- A: Yes, if you want decentralization, you either have ugly names or a blockchain. Meshname has ugly names, but it works at least!
## How to install and use
Minimum go version 1.12 is required. Minimum go version 1.12 is required.
@ -23,12 +33,12 @@ make
``` ```
./meshnamed -listenaddr [::1]:53535 -debug -useconffile /tmp/meshnamed.conf ./meshnamed -listenaddr [::1]:53535 -debug -useconffile /tmp/meshnamed.conf
``` ```
5) See list of all configuration flags 5) See the list of all configuration flags
``` ```
./meshnamed -help ./meshnamed -help
``` ```
Add new DNS records to configuration file and restart the daemon to apply settings. Add custom DNS records to the configuration file and restart the daemon to apply settings.
A record can be of any valid string form parsed by [miekg/dns](https://godoc.org/github.com/miekg/dns#NewRR). A DNS record can be of any valid string form parsed by [miekg/dns#NewRR](https://godoc.org/github.com/miekg/dns#NewRR) function (see example configuration file below).
## systemd unit ## systemd unit
@ -36,7 +46,7 @@ Look for `meshnamed.service` in the source directory for a systemd unit file.
## Example configuration file ## Example configuration file
In this example, meshnamed is configured as authoritative for two domain zones: In this example, meshnamed is configured as authoritative server for two domain zones:
{ {
"aiag7sesed2aaxgcgbnevruwpy": [ "aiag7sesed2aaxgcgbnevruwpy": [