From 87f1a4e9af23d70eb862d8a7221c590667553031 Mon Sep 17 00:00:00 2001 From: matthieugomez Date: Thu, 17 May 2018 11:12:55 -0400 Subject: [PATCH] def --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 702b1d8..55320a3 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ This Julia package computes various distances between strings. ## Syntax The package defines two functions: -- The function `evaluate` return the distance between two strings. -- The function `compare` returns a similarity score between two strings. The similarity score is inversely related to the distance, and is always between 0 and 1. A value of 0 being completely different and a value of 1 being completely similar. +- The function `evaluate` return the litteral distance between two strings. +- The function `compare` returns a similarity score between two strings, which is based on the inverse of the distance. The function always returns a score between 0 and 1, with a value of 0 being completely different and a value of 1 being completely similar. ```julia