From 53cb4e0321a94d7dc3ba4e5417573c270f000bf6 Mon Sep 17 00:00:00 2001 From: Phil Calouche Date: Thu, 8 Aug 2024 14:12:15 -0400 Subject: [PATCH] doc updates --- README.md | 11 +++-------- pom.xml | 5 +++-- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6585fd6..acb0f29 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,6 @@ -## Spring Skeleton +## Spring Forge Service Template -Spring Skeleton is a sample project to showcase the [Spring Forge Library](https://github.com/pcalouche/spring-forge) that uses Spring +Spring Forge Service Template is a sample project to showcase the [Spring Forge Library](https://github.com/pcalouche/spring-forge) that uses Spring Auto-configuration to help with the configuration of some things. -Spring Forge provides a status endpoint, standard controller advice exception handling, and Open Api documentation configured. Running this application and -going to [localhost:8080/swagger-ui.html](localhost:8080/swagger-ui.html) will display the Open Api documentation. From there you'll see two endpoints: - -1. /status - Demonstrates the status endpoint that is auto-configured by Spring Forge. -2. /exception-test - Demonstrates and endpoint that will throw and exception. The JSON response returned is derived from the code in Spring Forge. - +It demonstrates using the logging and controller advice configuration of Spring Forge. diff --git a/pom.xml b/pom.xml index 6003a8e..18e4381 100644 --- a/pom.xml +++ b/pom.xml @@ -11,9 +11,10 @@ dev.pcalouche - spring-forge-skeleton + spring-forge-service-template 1.0.0-SNAPSHOT - Skeleton Spring Boot Project that uses Spring Forge + Spring Forge Service Template is a Spring Boot application that demonstrates how to use Spring Forge + https://github.com/pcalouche/spring-forge-service-template