Skip to content

Commit fa7fb0d

Browse files
committed
Fix typo in README
1 parent 7875430 commit fa7fb0d

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To get started with Sprout, just follow these simple steps:
2525
- SpringBoot 3.5.x or higher
2626

2727
1. Add the Sprout-annotation dependency to your Maven project and the sprout-processor to the maven-compiler-plugin.
28-
2. Annotate your JPA entities with the `@SproutRessource` annotation.
28+
2. Annotate your JPA entities with the `@SproutResource` annotation.
2929
3. Run your SpringBoot application, and Sprout will automatically generate RESTful endpoints for your entities into your target folder.
3030

3131
### Maven
@@ -59,12 +59,12 @@ To get started with Sprout, just follow these simple steps:
5959

6060
### Example Entity
6161
```java
62-
import de.flix29.sprout.annotations.SproutRessource;
62+
import de.flix29.sprout.annotations.SproutResource;
6363
import jakarta.persistence.Entity;
6464
import jakarta.persistence.Id;
6565

6666
@Entity
67-
@SproutRessource
67+
@SproutResource
6868
public class Book {
6969
@Id
7070
private Long id;
@@ -113,7 +113,7 @@ Sprout also offers several optional features that you can enable by adding addit
113113
- `@SproutPolicy` Lets you define custom access policies for your each endpoint.
114114
- `@SproutId` Lets you define which field of your entity should be used as the ID field if you don't want to use the Database ID.
115115

116-
The `@SproutRessource` annotation also provides several configuration options:
116+
The `@SproutResource` annotation also provides several configuration options:
117117
- `path`: Customize the base path for the generated endpoints (default: `/api/{entity}`)
118118
- `generateSwaggerDocs`: Enable or disable Swagger documentation generation for the endpoints (default: true)
119119
- `name`: Customize the name of the resource used in the endpoint paths and swagger tag (default: entity class name in lowercase)
@@ -137,7 +137,7 @@ If you add the sprout-runtime dependency to your project, you can also use the f
137137
Sprout provides a unified error handling mechanism that returns consistent error responses for all endpoints.
138138
This is enabled by default when you include the sprout-runtime dependency. It'll provide the following parameters which can be set via the application.properties file:
139139
- `sprout.errors.enabled` - Whether the error handling is enabled (default: true)
140-
- `sprout.error.log-log-stacktraces` - Whether to include stack traces in error responses (default: false)
140+
- `sprout.error.log-stacktraces` - Whether to include stack traces in error responses (default: false)
141141
- `sprout.errors.internal-code` - The error code to log for internal server errors (default: internal-error)
142142

143143
### Method-Level Security

0 commit comments

Comments
 (0)