Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
trickl authored Mar 30, 2019
1 parent 91975e2 commit 9345bb5
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Trickl Sort

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.trickl/sort/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.trickl/sort)
[![build_status](https://travis-ci.com/trickl/sort.svg?branch=master)](https://travis-ci.com/trickl/sort)
[![Maintainability](https://api.codeclimate.com/v1/badges/c50441e8e5e10b31803f/maintainability)](https://codeclimate.com/github/trickl/sort/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/c50441e8e5e10b31803f/test_coverage)](https://codeclimate.com/github/trickl/sort/test_coverage)
Expand All @@ -12,15 +12,24 @@ Specialised sorting and selection algorithms -
* Ability to use a specialized permutator in sorting algorithms.
e.g. - A paired permutator, which allows users to efficiently simultaneously sort an array and generate the sort rank at the same time.

### Prerequisites
Installation
============

To install from Maven Central:

Requires Maven and a Java 8 compiler installed on your system.
```xml
<dependency>
<groupId>com.github.trickl</groupId>
<artifactId>sort</artifactId>
<version>0.1.1</version>
</dependency>
```

## Usage

See the Junit tests for usage

### Installing
### Building

To download the library into a folder called "sort" run

Expand Down

0 comments on commit 9345bb5

Please sign in to comment.