Open RJPercival opened 5 years ago
I'm not sure that the main README should have that level of detail at all, esp. the architectural diagrams. Esp. Kubernetes!
I think it should be just an index of various things. An example of a good README from my PoV: https://github.com/cockroachdb/cockroach.
A sizeable portion of the README is currently dedicated to information only useful to developers working on the code. Instead, we should rewrite it to only contain information that users need. We can link to a separate document that covers what contributors need to know.
Information that the README should contain:
Information that should be moved out of the README: