Skip to content

Commit a5c4f2c

Browse files
author
周哲超
committed
docs: readme change
1 parent 5a0bff7 commit a5c4f2c

File tree

1 file changed

+2
-17
lines changed

1 file changed

+2
-17
lines changed

README.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
A library implementing different string similarity, distance and sortMatch measures. A dozen of algorithms (including Levenshtein edit distance and sibblings, Longest Common Subsequence, cosine similarity etc.) are currently implemented. Check the summary table below for the complete list...
77

8-
- [string-comparison](#string-comparison)
98
- [Download & Usage](#download--usage)
109
- [OverView](#overview)
1110
- [Normalized, metric, similarity and distance](#normalized-metric-similarity-and-distance)
@@ -31,6 +30,7 @@ A library implementing different string similarity, distance and sortMatch measu
3130
- [1.x version](#1x-version)
3231
- [MIT](#mit)
3332

33+
3434
## Download & Usage
3535

3636
download
@@ -218,25 +218,10 @@ Return a number
218218

219219
#### params
220220

221-
1. thanos [String]
222-
2. avengers [Array]
223-
224-
#### return
225-
Return an array of objects
226-
```js
227-
[
228-
{ member: 'edward', index: 0, rating: 0.5 },
229-
{ member: 'theatre', index: 2, rating: 0.6153846153846154 },
230-
{ member: 'sealed', index: 1, rating: 0.8333333333333334 }
231-
]
232-
```
233-
234-
#### Params
235-
236221
1. thanos [String]
237222
2. avengers [...String]
238223

239-
#### Return
224+
#### return
240225

241226
Return an array of objects. ex:
242227
```js

0 commit comments

Comments
 (0)