Skip to content

Commit

Permalink
update Writerside
Browse files Browse the repository at this point in the history
  • Loading branch information
martinbonnin committed Nov 7, 2024
1 parent 0bf309e commit e61c1cc
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 28 deletions.
2 changes: 2 additions & 0 deletions Writerside/doc.tree
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@
<toc-element toc-title="GitHub" href="https://github.com/gradleup/librarian"/>
<toc-element toc-title="Kdoc" href="https://gradleup.github.io/librarian/kdoc"/>
<toc-element topic="welcome.md"/>
<toc-element topic="libraries.md"/>
<toc-element topic="cli.md"/>
</instance-profile>
28 changes: 1 addition & 27 deletions Writerside/topics/cli.md
Original file line number Diff line number Diff line change
@@ -1,27 +1 @@
# Librarian

Librarian is an opinionated toolkit to build Kotlin libraries. Librarian features:

* [Configuration-cache](https://docs.gradle.org/current/userguide/configuration_cache.html), [isolated projects](https://docs.gradle.org/current/userguide/isolated_projects.html) compatible publishing of KMP/Android/JVM libraries to:
* Maven Central using [default host](https://central.sonatype.org/publish/publish-guide/#releasing-to-central)
* Maven Central using [S01 host](https://central.sonatype.org/publish/publish-guide/#releasing-to-central)
* Maven Central using [the central portal API](https://central.sonatype.com/api-doc)
* OSS Sonatype snapshots using the default host
* OSS Sonatype snapshots using the S01 host
* [Google Cloud Storage](https://cloud.google.com/storage?hl=en)
* Versioned KDoc using [Dokka](https://github.com/Kotlin/dokka)
* Java and Kotlin compatibility helpers
* GitHub actions for testing, publishing and documentation
* Automatic generation of a symbol for your library version
* Binary Compatibility validator integration
* and more

Librarian is highly modular and has several parts that can be used independently:

* The `com.gradleup.librarian` Gradle plugin is an all-in-one plugin that configures sensible defaults for your library.
* The `librarian-cli` application is a companion CLI that lets you deal with several aspects of daily library development.
* The libraries contain the code that powers the `com.gradleup.librarian` plugin and can be used standalone.

## Get started

To add librarian to your root project:
# CLI
1 change: 1 addition & 0 deletions Writerside/topics/libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Libraries
2 changes: 1 addition & 1 deletion Writerside/topics/welcome.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Librarian
# Welcome

Librarian is an opinionated toolkit to build Kotlin libraries.

Expand Down

0 comments on commit e61c1cc

Please sign in to comment.