Skip to content

Commit 118842f

Browse files
authored
Add javadoc link and badge to the README.md file. (#67)
1 parent 74e99ca commit 118842f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# Aerospike Java Object Mapper
22
[![Build project](https://github.com/aerospike/java-object-mapper/actions/workflows/build.yml/badge.svg)](https://github.com/aerospike/java-object-mapper/actions/workflows/build.yml)
33
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.aerospike/java-object-mapper/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.aerospike/java-object-mapper/)
4+
[![javadoc](https://javadoc.io/badge2/com.aerospike/java-object-mapper/javadoc.svg)](https://javadoc.io/doc/com.aerospike/java-object-mapper)
45

56
[Aerospike](https://www.aerospike.com) is one of, if not the fastest, NoSQL database in the world. It presents a Java API which is comprehensive and powerful, but requires a measure of boiler plate code to map the data from Java POJOs to the database. The aim of this repository is to lower the amount of code required when mapping POJOs to Aerospike and back as well as reducing some of the brittleness of the code.
67

7-
# Table of contents:
8+
## Documentation
9+
10+
The documentation for this project can be found on [javadoc.io](https://www.javadoc.io/doc/com.aerospike/java-object-mapper).
11+
12+
# Table of contents
813
1. [Compatibility with Aerospike Clients](#Compatibility-with-Aerospike-Clients)
914
2. [Motivation and a simple example](#Motivation-and-a-simple-example)
1015
3. [Getting Started](#Getting-Started)

0 commit comments

Comments
 (0)