aboutsummaryrefslogtreecommitdiff
path: root/ufund-api/HELP.md
diff options
context:
space:
mode:
Diffstat (limited to 'ufund-api/HELP.md')
-rw-r--r--ufund-api/HELP.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/ufund-api/HELP.md b/ufund-api/HELP.md
new file mode 100644
index 0000000..f110fea
--- /dev/null
+++ b/ufund-api/HELP.md
@@ -0,0 +1,22 @@
+# Read Me First
+The following was discovered as part of building this project:
+
+* The original package name 'com.ufund.api.ufund-api' is invalid and this project uses 'com.ufund.api.ufundapi' instead.
+
+# Getting Started
+
+### Reference Documentation
+For further reference, please consider the following sections:
+
+* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
+* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/2.6.2/maven-plugin/reference/html/)
+* [Create an OCI image](https://docs.spring.io/spring-boot/docs/2.6.2/maven-plugin/reference/html/#build-image)
+* [Spring Web](https://docs.spring.io/spring-boot/docs/2.6.2/reference/htmlsingle/#boot-features-developing-web-applications)
+
+### Guides
+The following guides illustrate how to use some features concretely:
+
+* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
+* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
+* [Building REST services with Spring](https://spring.io/guides/tutorials/bookmarks/)
+