naijun0403/kompendium
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

chore: migrate to gitbook (#334)

Browse Source
This commit is contained in:
Ryan Brink
2022-09-29 15:41:35 -05:00
committed by GitHub
parent 6d6836927f
commit 622dd6a5e7
102043 changed files with 11 additions and 7228322 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -6,7 +6,6 @@
- [What Is Kompendium](#what-is-kompendium)
- [How to Install](#how-to-install)
- [Library Details](#library-details)
- [Local Development](#local-development)
- [The Playground](#the-playground)
@ -18,11 +17,11 @@ order to generate the appropriate spec.
### Compatability
| Kompendium | Ktor | OpenAPI |
|---|---| --- |
| 1.X | 1 | 3.0 |
| 2.X | 1 | 3.0 |
| 3.X | 2 | 3.1 |
| Kompendium | Ktor | OpenAPI |
|------------|------|---------|
| 1.X | 1 | 3.0 |
| 2.X | 1 | 3.0 |
| 3.X | 2 | 3.1 |
## How to install
@ -43,10 +42,6 @@ In addition to publishing releases to Maven Central, a snapshot version gets pub
to `main`. These can be consumed by adding the repository to your gradle build file. Instructions can be
found [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package)
# Library Details
Library documentation lives alongside the source code, and is generated into a static site via Dokka. Can be viewed [here](https://bkbnio.github.io/kompendium)
## Local Development
Kompendium should run locally right out of the box, no configuration necessary (assuming you have JDK 11+ installed).