Review and edit the README
Right now the README has a ton of details but not much in the way of providing context, explanations, or examples. A few things I'd like to focus on:
- Example configuration file for simply seeding a domain without subdomains.
- Example configuration file for setting subdomains.
- Remove some bullet points from first section. It's pretty long.
Jumping in to leave a note. I just worked through the homebase setup and it wasn't immediately clear to me how to set a dat to the base domain (I'm still not sure this is the preffered method). As you mentioned it might be useful to leave a note in the readme for fellow dat wayfarers looking to setup homebase.
For a domain like mydomain.com I wound up using something like
dats:
- url: dat://a1b2c3...
name: main
otherDomains:
- mydomain.com
This of course means main.mydomain.com and mydomain.com are the same, but on first glance it seemed the only way to do it.
That is the best way currently. It's not as easy as it should be.
How about splitting the readme up into separate files? We could create a /docs folder containing examples.md, api.md and so on with specific details about each section. The link to these files from the readme.