graphql-spring-boot icon indicating copy to clipboard operation
graphql-spring-boot copied to clipboard

Enhance README

Open blackduck-joe opened this issue 7 years ago • 2 comments

I came here via the link in the Baeldung article. I know usage of this project makes sense to you all, but as someone new to this all, the README is almost worthless. Pretend you don't actually "know", read the README and tell me what it does. What gradle(w) commands am supposed to run in order to do exactly what? The 'example' is an example of what? Even if you added a link inside the README to better documentation, that would be acceptable.

On the one hand, I see straight away I need to add those dependencies presumably to my own project. Then do I even need to clone this project??? Just not good...

blackduck-joe avatar May 24 '18 12:05 blackduck-joe

Why would you clone this repo? It are simply maven dependencies you have to add. Next to that I would read yourself into Spring Boot and Spring Boot Starters and how that works. I think with that information it is quite obvious how this project can be used.

marceloverdijk avatar Jul 06 '18 14:07 marceloverdijk

lol - yes, let's defend not having useful documentation because it is obvious to someone who already knows how to do it. Sorry, I completely missed that point.

blackduck-joe avatar Jul 06 '18 14:07 blackduck-joe