aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author zaaarf <me@zaaarf.foo>2024-01-19 17:28:19 +0100
committer zaaarf <me@zaaarf.foo>2024-01-19 17:28:19 +0100
commit05f9c98dcd9ad2c7f94c261d2675e91a639ffb66 (patch)
tree6babd621a7b3a5584b2b98eb5e7481e25fc746b6 /README.md
parente858d2017270da7e87bbaf362af028f4b788d321 (diff)
chore: added docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 56f689b..f5ca0e5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,4 @@
-# Route Mapper
-Just a little program I needed for work. Reads Spring's route mapping annotations in a project and writes down all about them. \ No newline at end of file
+# Route Compass
+An annotation processor that reads Spring Web's annotations to write down a map of all the routes in your projects: their paths, parameters, methods...
+
+It's a small program I found myself needing at work. Don't count on it being production-ready. \ No newline at end of file