summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2014-01-03 20:24:22 -0700
committerRocky Madden <git@rockymadden.com>2014-01-03 20:24:22 -0700
commitb32a03994b40d8b097d1af068192d886b00fe590 (patch)
tree5f073545bd9a41ae395cba70287a57c00c62d9ec
parent7b5297100ae32ab90d5682347880132237a7de33 (diff)
downloadstringmetric-b32a03994b40d8b097d1af068192d886b00fe590.tar.gz
stringmetric-b32a03994b40d8b097d1af068192d886b00fe590.tar.bz2
stringmetric-b32a03994b40d8b097d1af068192d886b00fe590.zip
Revamped decorating section.
-rwxr-xr-xreadme.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 4d562b3..7621f81 100755
--- a/readme.md
+++ b/readme.md
@@ -244,7 +244,11 @@ SoundexAlgorithm.compute("lukasiewicz") // l222
---
## Decorating
-It is possible to decorate algorithms and metrics with additional functionality. This is provided by rich wrapping via implicits, and [StringAlgorithmDecorator](https://github.com/rockymadden/stringmetric/blob/master/core/src/main/scala/com/rockymadden/stringmetric/Algorithm.scala)/[StringMetricDecorator](https://github.com/rockymadden/stringmetric/blob/master/core/src/main/scala/com/rockymadden/stringmetric/Metric.scala). A handful of pre-built transforms are located in the [transform module](https://github.com/rockymadden/stringmetric/blob/master/core/src/main/scala/com/rockymadden/stringmetric/Transform.scala).
+It is possible to decorate algorithms and metrics with additional functionality, this is provided by rich wrapping via implicits. Decorations include:
+
+* __withTransform:__ Transform arguments prior to computation/comparison. A handful of pre-built transforms are located in the [transform module](https://github.com/rockymadden/stringmetric/blob/master/core/src/main/scala/com/rockymadden/stringmetric/Transform.scala).
+
+* __withMemoization:__ Queued.
---