diff options
| author | Rocky Madden <git@rockymadden.com> | 2013-11-28 10:16:53 -0700 |
|---|---|---|
| committer | Rocky Madden <git@rockymadden.com> | 2013-11-28 10:16:53 -0700 |
| commit | 82220f3ecdf969672d2cfbc02410df03d08d9255 (patch) | |
| tree | 476d4dfb902246f11531f9fa07f92df288d3a80e | |
| parent | c9a468b4024a0f9b872998830c774c1915186e5c (diff) | |
| download | stringmetric-82220f3ecdf969672d2cfbc02410df03d08d9255.tar.gz stringmetric-82220f3ecdf969672d2cfbc02410df03d08d9255.tar.bz2 stringmetric-82220f3ecdf969672d2cfbc02410df03d08d9255.zip | |
Smashed sections into bullets.
| -rwxr-xr-x | readme.md | 20 |
1 files changed, 6 insertions, 14 deletions
@@ -1,5 +1,10 @@ #stringmetric [](http://travis-ci.org/rockymadden/stringmetric) [](https://coveralls.io/r/rockymadden/stringmetric) -String metrics and phonetic algorithms for Scala. The library provides facilities to perform approximate string matching, measurement of string similarity/distance, indexing by word pronunciation, and sounds-like comparisons. In addition to the core library, each metric and algorithm has a command line interface. +String metrics and phonetic algorithms for Scala. The library provides facilities to perform approximate string matching, measurement of string similarity/distance, indexing by word pronunciation, and sounds-like comparisons. In addition to the core library, each metric and algorithm has a command line interface. + +* __Requirements:__ Scala 2.10.x and, if building yourself, Gradle 1.6+ +* __ScalaDoc:__ [Available on the project website](http://rockymadden.com/stringmetric/scaladoc/) +* __Issues:__ [Enhancements](https://github.com/rockymadden/stringmetric/issues?labels=accepted%2Cenhancement&page=1&state=open), [Questions](https://github.com/rockymadden/stringmetric/issues?labels=accepted%2Cquestion&page=1&state=open), [Bugs](https://github.com/rockymadden/stringmetric/issues?labels=accepted%2Cbug&page=1&state=open) +* __Versioning:__ [Semantic Versioning v2.0](http://semver.org/) ## Metrics and algorithms * __[Dice / Sorensen](http://en.wikipedia.org/wiki/Dice%27s_coefficient)__ (Similarity metric) @@ -469,19 +474,6 @@ $ metaphonealgorithm dog tk ``` -## API -[Scaladoc](http://rockymadden.com/stringmetric/scaladoc/) is available on the project website. - -## Enhancements -[Issues labeled enhancement and accepted](https://github.com/rockymadden/stringmetric/issues?labels=accepted%2Cenhancement&page=1&state=open) indicate queued enhancements. - -## Requirements -* Scala 2.10.x -* Gradle 1.x - -## Versioning -[Semantic Versioning v2.0](http://semver.org/) - ## License ``` The MIT License (MIT) |