Skip to content

Commit

Permalink
docs: add short usage guide to project README
Browse files Browse the repository at this point in the history
  • Loading branch information
JanMalch committed Jul 19, 2024
1 parent f202c03 commit 17efec3
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,21 @@ A [Ktor server plugin](https://ktor.io/docs/server-plugins.html) made for automa
A revisioned file will include a short hash of its content in the file name.
This enables optimal caching without you ever having to change the name of the local file.

## Usage

```kotlin
package com.example

object AppAssets : RevFileRegistry("/assets/") {
val main = resource("main.js")
val styles = resource("styles.css")
}

fun Application.module() {
install(RevFilePlugin) {
+AppAssets
}
}
```

Checkout the [complete documentation](https://janmalch.github.io/ktor-revfile) for usage details.

0 comments on commit 17efec3

Please sign in to comment.