From c4e76ca6f242260e744807f329700455e67634d8 Mon Sep 17 00:00:00 2001 From: andrewlalis Date: Fri, 22 Dec 2023 10:51:54 -0500 Subject: [PATCH] Improve readme. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f2ea3d1..e86f2d3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ -# javafx-scene-router -Router navigation pattern implementation for JavaFX applications. +# JavaFX Scene Router + +A router implementation for navigating between "pages" in your JavaFX +application! + +On the web, we tend to take for granted the fact that you can click on a link, +go to a new page, then go back, go forward again, click on something else, and +it all works seamlessly to route you through the internet. In desktop apps, +that's less common, since most apps are simple enough to be built with a single +component tree. + +However, sometimes you'll want a web-like experience with your desktop app, and +for that purpose, I've created javafx-scene-router. It allows you to initialize +a router that controls the content of a Pane or similar, and depending on what +route is selected, different content will be shown in that pane.