What should go in the readme?

hyperboria / services

Services on Hyperboria

30 stars 10 forks source link

What should go in the readme? #3

Open ansuz opened 8 years ago

ansuz commented 8 years ago

The readme should be as brief as possible, but give a complete list of the features of the repo in short sections.

About
- reasons for this repo
Howto
- link to resources for setting up your first service on Hyperboria (these could be internal)
Policy
- what you must do to get listed in this repository
Asking questions
- where to go, who to contact, etc.
License
- If we need this. I am not a lawyer

ansuz commented 8 years ago

With regards to Policy && License, we're definitely going to need to address NSFW content and other questionable materials in advance. If something is a problem I would like to be able to remove it without having to form a committee.