Skip to content
This repository has been archived by the owner on Dec 27, 2022. It is now read-only.

Review and edit the README #5

Open
taravancil opened this issue May 2, 2018 · 3 comments
Open

Review and edit the README #5

taravancil opened this issue May 2, 2018 · 3 comments

Comments

@taravancil
Copy link
Contributor

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.
@taravancil taravancil self-assigned this May 2, 2018
@rh0
Copy link

rh0 commented May 16, 2018

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.

@pfrazee
Copy link
Member

pfrazee commented May 16, 2018

That is the best way currently. It's not as easy as it should be.

@Kovah
Copy link

Kovah commented Jul 11, 2019

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.

@taravancil taravancil removed their assignment May 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants