You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,8 @@ We also provide a command line tool that runs spring scripts.
11
11
Our primary goals are:
12
12
13
13
* Provide a radically faster and widely accessible getting started experience for all Spring development.
14
-
* Be opinionated out of the box, but get out of the way quickly as requirements start to diverge from the defaults.
15
-
* Provide a range of non-functional features that are common to large classes of projects (e.g. embedded servers, security, metrics, health checks, externalized configuration).
14
+
* Be opinionated, but get out of the way quickly as requirements start to diverge from the defaults.
15
+
* Provide a range of non-functional features common to large classes of projects (for example, embedded servers, security, metrics, health checks, externalized configuration).
16
16
* Absolutely no code generation and no requirement for XML configuration.
17
17
18
18
@@ -47,11 +47,11 @@ Here is a quick teaser of a complete Spring Boot application in Java:
47
47
48
48
49
49
== Getting help
50
-
Having trouble with Spring Boot? We'd like to help!
50
+
Are you having trouble with Spring Boot? We want to help!
51
51
52
52
* Check the {docs}/html/[reference documentation], especially the {docs}/html/howto.html#howto[How-to's] -- they provide solutions to the most common questions.
53
-
* Learn the Spring basics -- Spring Boot builds on many other Spring projects, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
54
-
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
53
+
* Learn the Spring basics -- Spring Boot builds on many other Spring projects; check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
54
+
If you are new to Spring, try one of the https://spring.io/guides[guides].
55
55
* If you are upgrading, read the {github}/wiki[release notes] for upgrade instructions and "new and noteworthy" features.
56
56
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-boot[`spring-boot`].
57
57
You can also chat with the community on https://gitter.im/spring-projects/spring-boot[Gitter].
@@ -65,9 +65,11 @@ If you want to raise an issue, please follow the recommendations below:
65
65
66
66
* Before you log a bug, please search the {github}/issues[issue tracker] to see if someone has already reported the problem.
67
67
* If the issue doesn't already exist, {github}/issues/new[create a new issue].
68
-
* Please provide as much information as possible with the issue report, we like to know the version of Spring Boot that you are using, as well as your Operating System and JVM version.
69
-
* If you need to paste code, or include a stack trace use Markdown +++```+++ escapes before and after your text.
70
-
* If possible try to create a test-case or project that replicates the problem and attach it to the issue.
68
+
* Please provide as much information as possible with the issue report.
69
+
We like to know the Spring Boot version, operating system, and JVM version you're using.
70
+
* If you need to paste code or include a stack trace, use Markdown.
71
+
+++```+++ escapes before and after your text.
72
+
* If possible, try to create a test-case or project that replicates the problem and attach it to the issue.
71
73
72
74
73
75
@@ -92,23 +94,23 @@ If you want to build everything, use the `build` task:
92
94
93
95
94
96
== Modules
95
-
There are a number of modules in Spring Boot, here is a quick overview:
97
+
There are several modules in Spring Boot. Here is a quick overview:
96
98
97
99
98
100
99
101
=== spring-boot
100
-
The main library providing features that support the other parts of Spring Boot, these include:
102
+
The main library providing features that support the other parts of Spring Boot. These include:
101
103
102
104
* The `SpringApplication` class, providing static convenience methods that can be used to write a stand-alone Spring Application.
103
105
Its sole job is to create and refresh an appropriate Spring `ApplicationContext`.
104
-
* Embedded web applications with a choice of container (Tomcat, Jetty or Undertow).
106
+
* Embedded web applications with a choice of container (Tomcat, Jetty, or Undertow).
105
107
* First class externalized configuration support,
106
108
* Convenience `ApplicationContext` initializers, including support for sensible logging defaults.
107
109
108
110
109
111
110
112
=== spring-boot-autoconfigure
111
-
Spring Boot can configure large parts of common applications based on the content of their classpath.
113
+
Spring Boot can configure large parts of typical applications based on the content of their classpath.
112
114
A single `@EnableAutoConfiguration` annotation triggers auto-configuration of the Spring context.
113
115
114
116
Auto-configuration attempts to deduce which beans a user might need. For example, if `HSQLDB` is on the classpath, and the user has not configured any database connections, then they probably want an in-memory database to be defined.
@@ -118,13 +120,13 @@ Auto-configuration will always back away as the user starts to define their own
118
120
119
121
=== spring-boot-starters
120
122
Starters are a set of convenient dependency descriptors that you can include in your application.
121
-
You get a one-stop-shop for all the Spring and related technology that you need without having to hunt through sample code and copy paste loads of dependency descriptors.
122
-
For example, if you want to get started using Spring and JPA for database access include the `spring-boot-starter-data-jpa` dependency in your project, and you are good to go.
123
+
You get a one-stop-shop for all the Spring and related technology you need without having to hunt through sample code and copy paste loads of dependency descriptors.
124
+
For example, if you want to get started using Spring and JPA for database access, include the `spring-boot-starter-data-jpa` dependency in your project, and you are good to go.
123
125
124
126
125
127
126
128
=== spring-boot-cli
127
-
The Spring command line application compiles and runs Groovy source, allowing you to write the absolute minimum of code to get an application running.
129
+
The Spring command line application compiles and runs Groovy source, allowing you to write the absolute minimum amount of code to get an application running.
128
130
Spring CLI can also watch files, automatically recompiling and restarting when they change.
129
131
130
132
@@ -133,7 +135,7 @@ Spring CLI can also watch files, automatically recompiling and restarting when t
133
135
Actuator endpoints let you monitor and interact with your application.
134
136
Spring Boot Actuator provides the infrastructure required for actuator endpoints.
135
137
It contains annotation support for actuator endpoints.
136
-
Out of the box, this module provides a number of endpoints including the `HealthEndpoint`, `EnvironmentEndpoint`, `BeansEndpoint` and many more.
138
+
This module provides many endpoints, including the `HealthEndpoint`, `EnvironmentEndpoint`, `BeansEndpoint`, and many more.
137
139
138
140
139
141
@@ -151,8 +153,8 @@ This module contains core items and annotations that can be helpful when testing
151
153
152
154
153
155
=== spring-boot-test-autoconfigure
154
-
Like other Spring Boot auto-configuration modules, spring-boot-test-autoconfigure, provides auto-configuration for tests based on the classpath.
155
-
It includes a number of annotations that can be used to automatically configure a slice of your application that needs to be tested.
156
+
Like other Spring Boot auto-configuration modules, spring-boot-test-autoconfigure provides auto-configuration for tests based on the classpath.
157
+
It includes many annotations that can automatically configure a slice of your application that needs to be tested.
156
158
157
159
158
160
@@ -163,21 +165,21 @@ Generally you will not need to use `spring-boot-loader` directly, but instead wo
163
165
164
166
165
167
=== spring-boot-devtools
166
-
The spring-boot-devtools module provides additional development-time features such as automatic restarts, for a smoother application development experience.
168
+
The spring-boot-devtools module provides additional development-time features, such as automatic restarts, for a smoother application development experience.
167
169
Developer tools are automatically disabled when running a fully packaged application.
168
170
169
171
170
172
171
173
== Samples
172
174
Groovy samples for use with the command line application are available in link:spring-boot-project/spring-boot-cli/samples[spring-boot-cli/samples].
173
-
To run the CLI samples type `spring run <sample>.groovy` from samples directory.
175
+
To run the CLI samples, type `spring run <sample>.groovy` from the samples directory.
174
176
175
177
176
178
177
179
== Guides
178
180
The https://spring.io/[spring.io] site contains several guides that show how to use Spring Boot step-by-step:
179
181
180
-
* https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot] is a very basic guide that shows you how to create an application, run it and add some management services.
182
+
* https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot] is an introductory guide that shows you how to create an application, run it, and add some management services.
181
183
* https://spring.io/guides/gs/actuator-service/[Building a RESTful Web Service with Spring Boot Actuator] is a guide to creating a REST web service and also shows how the server can be configured.
182
184
* https://spring.io/guides/gs/convert-jar-to-war/[Converting a Spring Boot JAR Application to a WAR] shows you how to run applications in a web server as a WAR file.
0 commit comments