Skip to content

Commit

Permalink
shorten readme and remove badges
Browse files Browse the repository at this point in the history
GitHub UI does a good job of highlighting the current version,
IMO
  • Loading branch information
SethTisue committed Mar 11, 2024
1 parent e4891bf commit 1ac43de
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit 1ac43de

Please sign in to comment.