Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Zabuzard authored Feb 12, 2021
1 parent a56c4c2 commit 08c3fe1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Closy
[![license](https://img.shields.io/github/license/Zabuzard/Closy)](https://img.shields.io/github/license/Zabuzard/Closy) [![maven-central](https://img.shields.io/maven-central/v/io.github.zabuzard.closy/closy)](https://img.shields.io/maven-central/v/io.github.zabuzard.closy/closy) [![javadoc](https://javadoc.io/badge2/io.github.zabuzard.closy/closy/javadoc.svg)](https://javadoc.io/doc/io.github.zabuzard.closy/closy) [![Java](https://img.shields.io/badge/Java-9%2B-ff696c)](https://img.shields.io/badge/Java-9%2B-ff696c)
[![maven-central](https://img.shields.io/maven-central/v/io.github.zabuzard.closy/closy)](https://img.shields.io/maven-central/v/io.github.zabuzard.closy/closy) [![javadoc](https://javadoc.io/badge2/io.github.zabuzard.closy/closy/javadoc.svg)](https://javadoc.io/doc/io.github.zabuzard.closy/closy) [![Java](https://img.shields.io/badge/Java-9%2B-ff696c)](https://img.shields.io/badge/Java-9%2B-ff696c) [![license](https://img.shields.io/github/license/Zabuzard/Closy)](https://img.shields.io/github/license/Zabuzard/Closy)

Closy is a simple library for efficient **nearest neighbor computations**. It is designed generic and can be used
with **any class** that defines a [metric](https://en.wikipedia.org/wiki/Metric_(mathematics)).
Expand Down Expand Up @@ -35,7 +35,7 @@ Jar downloads are available from the [release section](https://github.com/Zabuza

# Getting started

1. Integrate **Closy** into your project.
1. Integrate **Closy** into your project. The API is contained in the module `io.github.zabuzard.closy`.
2. Create an implementation of `Metric<E>` for your custom `E` objects
3. Create an algorithm using `NearestNeighborComputations#of(Metric<E>)`
4. Add your objects to the algorithm using `NearestNeighborComputation#add(E)`
Expand Down

0 comments on commit 08c3fe1

Please sign in to comment.