diff --git a/.gitignore b/.gitignore index 3789456b34c7084cabaa5bb6e7d6126b44437ecc..ac9e54f68d74240047b85ea99f897479dbddbc8a 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,7 @@ build/ *.iml *.ipr *.iws +.classpath +.project +.settings/ +bin/ diff --git a/.meta/images/exampleAuthModal.png b/.meta/images/exampleAuthModal.png new file mode 100644 index 0000000000000000000000000000000000000000..80fff0b6b677b0f3289da1a4843bf6498d61c854 Binary files /dev/null and b/.meta/images/exampleAuthModal.png differ diff --git a/.meta/images/exampleEndpoint.png b/.meta/images/exampleEndpoint.png new file mode 100644 index 0000000000000000000000000000000000000000..dd6205b29ea6a282066fca6492bb0885c0772bf8 Binary files /dev/null and b/.meta/images/exampleEndpoint.png differ diff --git a/README.md b/README.md index 722322b91db370ae31ac9423556838e1d2f543b5..43cf6b346201f3556b11fb50dfabf22230de6f33 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ Ktor-Docs [![JitPack](https://jitpack.io/v/dev.horrific.code.james/ktordocs.svg) This library automatically generates REST API documentation for Ktor/JVM projects and hosts it under a specified URL. +## Screenshots + +| Endpoint | Auth Info | +|----------|-----------| +| ![img](./.meta/images/exampleEndpoint.png) | ![img](.meta/images/exampleAuthModal.png) | + ## Installation The `:docs` module is published on [JitPack](https://jitpack.io/), which you can add to your project by copying the following to your root build.gradle at the end of "repositories".