My readme files have always been a maximum of one statement. I guess i had not wrapped my head around the necessity of a readme file. I'm still tying to figure out what goes to a readme especially for an API project. For a start the readme generator was quite useful. I came up with this readme for my sales API project.
It's certainly not the best in town but i consider it a great improvement.
Top comments (0)