diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba9cf6a..a7517cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to SPI-Tooling -Firstly, thank you for taking the time contribute! +Firstly, thank you for taking the time to contribute! SPI-Tooling exists to make service loading easier, and your ideas, fixes and improvements help make that possible. This guide will walk you through how to set up your environment, make changes, and submit them in a way that keeps the project reproducible and contributor-friendly. @@ -108,4 +108,4 @@ Releases are automated via GitHub Actions and occur when a push or merge is made ## Tips for Contributors - Keep changes focused - small, atomic PRs are easier to review - If you're unsure about an approach, open a Draft PR early for feedback -- Think about future maintainers - clear code, clear cods, clear tests \ No newline at end of file +- Think about future maintainers - clear code, clear docs, clear tests diff --git a/README.md b/README.md index 0d2543f..3044aae 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Annotations Maven Central](https://img.shields.io/maven-central/v/io.github.eventhorizonlab/spi-tooling-annotations?color=blue)](https://central.sonatype.com/artifact/io.github.eventhorizonlab/spi-tooling-annotations) [![Processor Maven Central](https://img.shields.io/maven-central/v/io.github.eventhorizonlab/spi-tooling-processor?color=blue)](https://central.sonatype.com/artifact/io.github.eventhorizonlab/spi-tooling-processor) [![Build](https://github.com/EventHorizonLab/SPI-Tooling/actions/workflows/release-and-publish.yml/badge.svg)](https://github.com/EventHorizonLab/SPI-Tooling/actions) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.md) --- ## 📖 Overview @@ -18,7 +18,7 @@ This is designed for: --- ## ✨ Features -- **Annotation‑driven**: Mark your contracts with `@ServiceContract` and service implementations with `@ServiceProvider(Contract:class)` +- **Annotation‑driven**: Mark your contracts with `@ServiceContract` and service implementations with `@ServiceProvider(Contract::class)` - **Automatic `META-INF/services` generation** at compile time. - **Multi‑module aware**: Handles aggregation across modules without collisions. - **Deterministic output**: Stable ordering for reproducible builds. @@ -181,4 +181,4 @@ Manual SPI file management is: - Error-prone (typos, missing entries) - Hard to maintain in multi-module setups - A barrier for new contributors -`spi-tooling` makes it automatic, safe, and reproducible -- so you can focus on building features, not maintaing service files. \ No newline at end of file +`spi-tooling` makes it automatic, safe, and reproducible -- so you can focus on building features, not maintaining service files.