Skip to content

Commit 549fa3c

Browse files
committed
docs: add comprehensive README with usage instructions
1 parent 6ca4f82 commit 549fa3c

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LSD Kotlin Conventions
22

3-
A Gradle convention plugin for standardizing build configurations across LSD projects.
3+
Gradle convention plugins for LSD projects.
44

55
## Overview
66

@@ -9,47 +9,46 @@ This project provides Gradle convention plugins that encapsulate common build lo
99
## Plugins
1010

1111
### `lsd.library`
12-
Basic Java library conventions including:
13-
- Java 17 compatibility
14-
- Maven Central repository
12+
Base plugin for Java libraries with:
13+
- Java 17 toolchain
14+
- Maven Central publishing
1515
- Common test dependencies (JUnit 5, AssertJ)
1616
- Test configuration with proper logging
1717

1818
### `lsd.kotlin-library`
19-
Kotlin library conventions (extends `lsd.library`) including:
19+
Extends `lsd.library` with Kotlin-specific features:
2020
- Kotlin JVM plugin with Java 17 toolchain
21-
- Dokka for documentation generation
22-
- JaCoCo for code coverage (version 0.8.12)
21+
- Dokka documentation generation
22+
- JaCoCo test coverage
2323
- Sources and Javadoc JAR generation
2424
- Git hooks installation task
2525

2626
## Usage
2727

28-
### In your `settings.gradle` or `settings.gradle.kts`:
28+
### In your `settings.gradle.kts`:
2929

3030
```kotlin
3131
pluginManagement {
3232
repositories {
33-
mavenLocal()
3433
gradlePluginPortal()
3534
mavenCentral()
3635
}
3736
}
3837
```
3938

40-
### In your `build.gradle`:
39+
### In your `build.gradle.kts`:
4140

42-
```groovy
41+
```kotlin
4342
plugins {
44-
id 'lsd.kotlin-library' version '1.0.0'
43+
id("lsd.kotlin-library") version "1.0.0"
4544
}
4645
```
4746

48-
### In your `build.gradle.kts`:
47+
### For Java-only projects:
4948

5049
```kotlin
5150
plugins {
52-
id("lsd.kotlin-library") version "1.0.0"
51+
id("lsd.library") version "1.0.0"
5352
}
5453
```
5554

0 commit comments

Comments
 (0)