Skip to content

Commit a66f573

Browse files
committed
Update README.md
1 parent 4991e14 commit a66f573

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</a>
2222
</p>
2323

24-
> Golang string comparison and edit distance algorithms library featuring : Levenshtein, LCS, Hamming, Damerau levenshtein (OSA and Adjacent transpositions algorithms), Jaro-Winkler, etc...
24+
> Golang string comparison and edit distance algorithms library featuring : Levenshtein, LCS, Hamming, Damerau levenshtein (OSA and Adjacent transpositions algorithms), Jaro-Winkler, Cosine, etc...
2525
2626
---
2727

@@ -31,6 +31,7 @@
3131
- [Introduction](#introduction)
3232
- [Features](#features)
3333
- [Installation](#installation)
34+
- [Benchmarks](#benchmarks)
3435
- [Documentation](#documentation)
3536
- [Author](#author)
3637
- [Contributing](#-contributing)
@@ -55,14 +56,22 @@ This library is 100% test covered 😁
5556
- OSA (Optimal string alignment) ✨
5657
- Adjacent transpositions ✨
5758
- [Jaro & Jaro-Winkler](https://fr.wikipedia.org/wiki/Distance_de_Jaro-Winkler) similarity algorithms ✨
59+
- [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) algorithm to compare strings ✨
5860

5961
- Computed similarity percentage functions based on all available edit distance algorithms in this lib ✨
6062
- Fuzzy search functions based on edit distance with unique or multiples strings output ✨
6163
- Unicode compatibility ! 🥳
62-
- Many more to come !
64+
- And many more to come !
65+
66+
## Benchmarks
67+
You can check an interactive Google chart with few benchmark cases for all similarity algorithms in this library through **StringSimilarity** function [here](http://benchgraph.codingberg.com/q5)
68+
69+
However, if you want or need more details, you can also viewing benchmark raw output [here](https://github.com/hbollon/go-edlib/blob/master/tests/outputs/benchmarks.txt), which also includes memory allocations and test cases output (similarity result and errors).
70+
71+
If you are on Linux and want to run them on your setup, you can run ``` ./tests/benchmark.sh ``` script.
6372

6473
## Installation
65-
Open bash into you project folder and run :
74+
Open bash into your project folder and run :
6675

6776
```bash
6877
go get github.com/hbollon/go-edlib
@@ -71,9 +80,12 @@ go get github.com/hbollon/go-edlib
7180
And import it into your project.
7281

7382
### Run tests
74-
If you want to run all units tests just run :
83+
If you are on Linux and want to run all unit tests just run ``` ./tests/tests.sh ``` script.
84+
85+
For Windows users you can run :
86+
7587
```bash
76-
go test ./... -coverpkg=./... # Add desired parameters to this command if you want
88+
go test ./... # Add desired parameters to this command if you want
7789
```
7890

7991
## Documentation

0 commit comments

Comments
 (0)