diff --git a/README.md b/README.md index c4e9dc6..df223f7 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,19 @@ Once you have installed micro match, simply include it in your project like so.. const match = require('micro-match'); ``` +## Usage + +micro match exposes a single method which allows you to match a route binding to it's real world counterpart and return it's bindings. + +```javascript +const {id} = match('/users/:id', '/users/1'); +``` +Parameters are defined as a comma followed by an alias to bind it's value to. + +You can also create optional parameters by attaching a `?` suffix. This will allow both `/users` and `/users/1` to be matched. + +Now you will be able to access the `id` parameter with the value of `1` and handle it however ever you like. + ## Changes Details for each release are documented in the [release notes](CHANGELOG.md).