Browse Source

add demo screenshots to readme

main
James Fenn 5 months ago
parent
commit
d137f09e7c
4 changed files with 10 additions and 0 deletions
  1. +4
    -0
      .gitignore
  2. BIN
      .meta/images/exampleAuthModal.png
  3. BIN
      .meta/images/exampleEndpoint.png
  4. +6
    -0
      README.md

+ 4
- 0
.gitignore View File

@@ -5,3 +5,7 @@ build/
*.iml
*.ipr
*.iws
.classpath
.project
.settings/
bin/

BIN
.meta/images/exampleAuthModal.png View File

Before After
Width: 1227  |  Height: 828  |  Size: 97 KiB

BIN
.meta/images/exampleEndpoint.png View File

Before After
Width: 1213  |  Height: 825  |  Size: 88 KiB

+ 6
- 0
README.md View File

@@ -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".


Loading…
Cancel
Save