From 41d0d341d8c840c56bd428d92dd25774e8d0eae6 Mon Sep 17 00:00:00 2001 From: Tim Nieradzik Date: Fri, 1 Mar 2019 20:02:40 +0100 Subject: [PATCH] README: Add section outlining features --- README.md | 10 ++++++++++ manual/introduction.md | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a140ef5..83a2f9e 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ Trail is a routing library for Scala. It is available for the JVM, Scala.js and Scala Native. +## Features +* Define type-safe routes +* Parse and generate URLs +* DSL to extract path elements, arguments and fragments +* Express routing tables via pattern matching +* Define custom codecs +* IDE support +* Cross-platform support (JVM, Scala.js, Scala Native) +* Zero dependencies + ## Example ```scala import trail._ diff --git a/manual/introduction.md b/manual/introduction.md index b3a8a97..d470f08 100644 --- a/manual/introduction.md +++ b/manual/introduction.md @@ -9,7 +9,7 @@ libraryDependencies += "tech.sparse" %% "trail" % "%version%" // Scala libraryDependencies += "tech.sparse" %%% "trail" % "%version%" // Scala.js, Scala Native ``` -## Example +## Usage Create a route: