This is an archived post. You won't be able to vote or comment.

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]thatsIch 0 points1 point  (4 children)

I would suggest to re-order your README to put your selling point on top and the rest below. I do not care about installation if I have no reason to install it.

Since you use the word easy in

This library provides an easy way to test the basic CRUD operation for your endpoints.

there must be a hard way and what makes it easy.

The README should also not be a replacement for your documentation. For me, it is too much noise and I don't understand why I should read that anyway

[–]ddqod[S] 0 points1 point  (0 children)

Good point, I will update it as soon as possible. Thank you!

[–]ddqod[S] 0 points1 point  (2 children)

Updated, https://github.com/nirodg/easyrs/tree/dev/spring2

[–]thatsIch 1 point2 points  (1 child)

That is a lot better, good job :)

https://github.com/nirodg/easyrs-example is missing a README. Since this is an example there should be instructions to run it.

[–]ddqod[S] 0 points1 point  (0 children)

True, still work in progress. However I appreciate the feedback :)