DOCUMENTATION.md or Just the README?

fsprojects / FSharp.Data.JsonSchema

MIT License

49 stars 6 forks source link

DOCUMENTATION.md or Just the README? #6

Closed panesofglass closed 4 years ago

panesofglass commented 4 years ago

I was going to start adding more documentation as I try to get this to a 1.0 release. Should I follow @dustinmoris approach of using a DOCUMENTATION.md or just put it all in the README?

matthewcrews commented 4 years ago

In my opinion, a README is sufficient especially if there is a Table of Contents with links.