Skip to content

Commit b55292e

Browse files
committed
Prepare release 1.0.0
1 parent 9ceeafa commit b55292e

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,25 @@ The library can create links for
1212
* methods and constructors
1313
* fields
1414

15-
based on the internal names (class files) or on Java reflection types. For example
16-
this snippet creates a link to the `String` class:
15+
based on the internal names (class files) or on Java reflection types.
16+
17+
18+
## Usage
19+
20+
The latest version can be obtained with the following Maven dependency:
21+
22+
```xml
23+
<dependency>
24+
<groupId>io.javaalmanac</groupId>
25+
<artifactId>javadoclink</artifactId>
26+
<version>1.0.0</version>
27+
</dependency>
28+
```
29+
30+
The only public interface of the library is `io.javaalmanac.javadoclink.JavaDocLink`. It
31+
is used to get instances, the base URL and retrieve links for different Java
32+
language elements. This For example this snippet creates a link to the
33+
`java.lang.String` class:
1734

1835
```java
1936
JavaDocLink.forVersion("11")

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
<modelVersion>4.0.0</modelVersion>
55
<groupId>io.javaalmanac</groupId>
66
<artifactId>javadoclink</artifactId>
7-
<version>0.0.1-SNAPSHOT</version>
7+
<version>1.0.0</version>
88

99
<name>io.javaalmanac.javadoclink</name>
1010
<description>Generator for Javadoc deep links</description>
1111
<url>https://github.com/marchof/io.javaalmanac.javadoclink</url>
1212
<inceptionYear>2021</inceptionYear>
1313
<organization>
14-
<name>Mountainminds GmbH Co. KG</name>
14+
<name>Mountainminds GmbH &amp; Co. KG</name>
1515
</organization>
1616

1717
<licenses>

0 commit comments

Comments
 (0)