Improve readme.

This commit is contained in:
Andrew Lalis 2023-12-22 10:51:54 -05:00
parent 7ff7716971
commit c4e76ca6f2
1 changed files with 15 additions and 2 deletions

View File

@ -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.