This message was deleted.
# announcements
s
This message was deleted.
👏 3
m
An advice about the README: it’s not clear upon first read that it’s a service you have to start up (reading “non-persistent KV store” made me think that it could be embeddable in-memory, so I was looking for a code sample), not to mention you have to send commands through telnet. When I read a good introductory document on a Github project, I expect to find a brief description of • what’s this thing • why I would need it / what problem it solves • a quick usage example I don’t want to read how to build the project, that’s a secondary info, usually relegated at the end of the document. In your case, given the unusual architecture and setup, it should be explained clearly and shortly at the beginning. Hope this helps you improving the documentation!