From 1ac43de0cf39e23cb13f1e85ab26a9984e2cbbf4 Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Mon, 11 Mar 2024 22:26:36 +0100 Subject: [PATCH] shorten readme and remove badges GitHub UI does a good job of highlighting the current version, IMO --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index e95cd6e..92d0c03 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,5 @@ -# GenJavadoc - -[![Test and publish](https://github.com/lightbend/genjavadoc/actions/workflows/validate.yml/badge.svg?branch=main)](https://github.com/lightbend/genjavadoc/actions/workflows/validate.yml) - This project’s goal is the creation of real Javadoc for Scala projects. While Scaladoc—the native API documentation format of Scala—has several benefits over Javadoc, Java programmers are very much used to having access to API documentation in a syntax matching their programming language of choice. Another motivating factor may be that javadoc-JARs are supported within IDE, e.g. showing tooltip help texts. -## Latest Version - -[![Latest version](https://img.shields.io/maven-central/v/com.typesafe.genjavadoc/genjavadoc-plugin_2.13.13)] - ## How to Use It GenJavadoc is a Scala compiler plugin which emits structurally equivalent Java code for all Scala sources of a project, keeping the Scaladoc comments (with a few format adaptions). Integration into an SBT build is quite simple: