Skip to content

Commit 05b29ab

Browse files
committed
docs: update readme docs
Signed-off-by: Otavio Santana <[email protected]>
1 parent 6955f74 commit 05b29ab

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.adoc

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
= embedded-mongodb
1+
= Jakarta NoSQL with MongoDB: Exploring Embedded Documents and Flexibility
22

3-
Sample Helidon MP project that includes multiple REST operations for managing products.
3+
This project demonstrates the use of Jakarta NoSQL with MongoDB, leveraging the flexibility of Helidon MP to build a sample RESTful API for managing products. The focus is on showcasing how MongoDB's embedded document model works in conjunction with Jakarta NoSQL, emphasizing:
4+
5+
- The simplicity of modeling entities with embedded types.
6+
- Flexibility in handling relationships such as `One-to-One`, `One-to-Many`, and `Many-to-Many`.
7+
- Dynamic schemas and their adaptability to real-world use cases.
8+
9+
The project serves as a practical guide for developers to understand how to use Jakarta NoSQL annotations to map MongoDB documents, demonstrating MongoDB's unique capabilities for handling flexible and embedded data structures.
410

511
== Build and Run
612

@@ -47,6 +53,14 @@ curl -X GET http://localhost:8080/products/{id}
4753
curl -X DELETE http://localhost:8080/products/{id}
4854
----
4955

56+
== Project Goals
57+
58+
This project highlights:
59+
- **Jakarta NoSQL Integration with MongoDB**: Demonstrating how Jakarta NoSQL simplifies database interactions using annotations and abstractions.
60+
- **MongoDB Embedded Documents**: Showcasing the use of embedded types (`Manufacturer` and `Category`) to take advantage of MongoDB’s schema-less design.
61+
- **Flexibility of MongoDB**: Illustrating how MongoDB handles arrays, embedded objects, and relationships without requiring a rigid schema.
62+
- **Helidon MP as a Lightweight Framework**: Using Helidon MP for building modern REST APIs with minimal configuration and overhead.
63+
5064
== Try Health
5165

5266
[source,bash]

0 commit comments

Comments
 (0)