BerlinVagrant / vagrant-dns

A plugin to manage DNS records for vagrant environments
MIT License
490 stars 50 forks source link

Clarify examples in README #81

Open mexon opened 6 months ago

mexon commented 6 months ago

I found the examples in the README pretty confusing.

The examples as given don't actually produce the documented output, largely because the main example includes custom patterns. The example output of --list assumes you did include custom patterns, but the example output of resolvectl query assumes you did not.

Also it dives straight into using a prefix instead of simply the configured domain name. A naive user like me probably just wants "machine.test", so why is it talking about "test.machine.test"? Is the prefix supposed to be the same as the TLD?

So I moved the custom patterns stuff to a separate section. I removed the prefixes and instead added a small note. And I tidied up the example output to be consistent with the simplest case.