The original ReadMe does not have a caption associated with the sample program shown, hence it might not be as beginner-friendly to those who are not familiar with spring annotations. I have added a caption/description to the sample program which describes the 3 spring annotations used within the example program.
Comment From: pivotal-cla
@faizak1 Please sign the Contributor License Agreement!
Click here to manually synchronize the status of this Pull Request.
See the FAQ for frequently asked questions.
Comment From: pivotal-cla
@faizak1 Thank you for signing the Contributor License Agreement!
Comment From: snicoll
@faizak1 thanks for the proposal. I wonder what the current version missed in terms of additional information. There is a link above the code sample that links to https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/html/getting-started.html#getting-started.first-application.code.mvc-annotations. The explanations on these annotations shouldn't be duplicated ideally.
There are also a bunch of other concepts that may confuse newcomers. For instance, if you don't have the required dependency, no web server will start.
What do you think?
Comment From: snicoll
I am going to close this now as I don't think the teaser is the right place for explaning those concepts, and they are covered in the getting started guide that is linked above the example. Thanks for the PR in any case!