Documentation

hal · Mar 5, 2024 · 78c85a3 · 78c85a3
1 parent d1b33bf
commit 78c85a3
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -34,8 +34,8 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 Elemento now contains a very basic place manager. The place manager is minimal invasive and built around a few simple concepts:
 
 - `Route`: Annotation that can be used to decorate pages. An annotation processor collects all classes annotated with `@Route` and generates an implementation of `Routes`. 
-- `Routes`: Provides a collection of places and their corresponding pages.
-- `Place`: Class that represents a place in an application. A place is identified by a route, and can have an optional title and a custom root element.
+- `Routes`: Provides a map of places and their corresponding pages.
+- `Place`: Data class that represents a place in an application. A place is identified by a route, and can have an optional title and a custom root element.
 - `Page`: Interface that represents a collection of HTML elements.
 - `PlaceManager`: Class responsible for managing the routing and navigation within an application.
 

diff --git a/README.md b/README.md
@@ -24,6 +24,7 @@ Elemento simplifies working with GWT [Elemental2](https://github.com/google/elem
 * [SVG & MathML](#svg--mathml)
   * [SVG](#svg)
   * [MathML](#mathml)
+* [Router](#router)
 * [Samples](#samples)
 * [Contributing](#contributing)
 * [Get Help](#get-help)
@@ -357,6 +358,20 @@ In your GWT module inherit from `org.jboss.elemento.MathML`:
 
 Finally, use the static methods in `org.jboss.elemento.mathml.MathML` to create MathML elements.
 
+# Router
+
+Elemento offers a very basic router. The router is minimal invasive and built around a few simple concepts:
+
+- `Route`: Annotation that can be used to decorate pages. An annotation processor collects all classes annotated with `@Route` and generates an implementation of `Routes`.
+- `Routes`: Provides a map of places and their corresponding pages.
+- `Place`: Data class that represents a place in an application. A place is identified by a route, and can have an optional title and a custom root element.
+- `Page`: Interface that represents a collection of HTML elements.
+- `PlaceManager`: Class responsible for managing the routing and navigation within an application.
+
+## Place manager
+
+The place manager is the central part of the router module. It offers builder like methods to configure the place manager and a `start()` method to show the initial page.  
+
 # Samples
 
 Elemento comes with different [implementations](https://github.com/hal/elemento-samples) of the [TodoMVC](http://todomvc.com/) application using different frameworks: