README.md

# nif_strsort
[![CircleCI](https://circleci.com/gh/ukrbublik/nif_strsort.svg?style=svg)](https://circleci.com/gh/ukrbublik/nif_strsort)

NIF sorting list of strings done with C++

### Usage
```elixir
Strsort.sort(["xir", "i", "el"])
# ["el", "i", "xir"]
```

### Installation
Add to `deps` in `mix.exs`:
```elixir
{:strsort, "~> 0.1.0"}
```
Works on Elixir 1.7+

### Performance
- See [benchmark](bench.md)
- Slightly wins by speed on big data (> 100K).
- Memory usage is much more effective on any data.

### Commands
- Interactive shell:
```sh
$ make cli
```
- Run benchmarks:
```sh
$ make bench
$ make bench/fast
```
- Run tests:
```sh
$ make test
```