From e61c1cc41bae41c711a19640dc90780add16d8e7 Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Thu, 7 Nov 2024 14:19:32 +0100 Subject: [PATCH] update Writerside --- Writerside/doc.tree | 2 ++ Writerside/topics/cli.md | 28 +--------------------------- Writerside/topics/libraries.md | 1 + Writerside/topics/welcome.md | 2 +- 4 files changed, 5 insertions(+), 28 deletions(-) diff --git a/Writerside/doc.tree b/Writerside/doc.tree index 2861816..73a19b1 100644 --- a/Writerside/doc.tree +++ b/Writerside/doc.tree @@ -9,4 +9,6 @@ + + \ No newline at end of file diff --git a/Writerside/topics/cli.md b/Writerside/topics/cli.md index 8d7b901..db3cc67 100644 --- a/Writerside/topics/cli.md +++ b/Writerside/topics/cli.md @@ -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: \ No newline at end of file +# CLI \ No newline at end of file diff --git a/Writerside/topics/libraries.md b/Writerside/topics/libraries.md index e69de29..3290d70 100644 --- a/Writerside/topics/libraries.md +++ b/Writerside/topics/libraries.md @@ -0,0 +1 @@ +# Libraries diff --git a/Writerside/topics/welcome.md b/Writerside/topics/welcome.md index eeddf47..8236ec9 100644 --- a/Writerside/topics/welcome.md +++ b/Writerside/topics/welcome.md @@ -1,4 +1,4 @@ -# Librarian +# Welcome Librarian is an opinionated toolkit to build Kotlin libraries.