Skip to content
This repository was archived by the owner on May 1, 2023. It is now read-only.

Commit f83ba3c

Browse files
committed
readme changes
1 parent 68da344 commit f83ba3c

File tree

3 files changed

+21
-18
lines changed

3 files changed

+21
-18
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,22 @@ Finds degree of similarity between two strings, based on [Dice's Coefficient](ht
66
## Table of Contents
77

88
* [Usage](#usage)
9+
+ [For Node.js](#for-nodejs)
10+
+ [For browser apps](#for-browser-apps)
911
* [API](#api)
10-
* [compareTwoStrings(string1, string2)](#comparetwostringsstring1-string2)
11-
* [Arguments](#arguments)
12-
* [Returns](#returns)
13-
* [Examples](#examples)
14-
* [findBestMatch(mainString, targetStrings)](#findbestmatchmainstring-targetstrings)
15-
* [Arguments](#arguments-1)
16-
* [Returns](#returns-1)
17-
* [Examples](#examples-1)
12+
+ [compareTwoStrings(string1, string2)](#comparetwostringsstring1-string2)
13+
* [Arguments](#arguments)
14+
* [Returns](#returns)
15+
* [Examples](#examples)
16+
+ [findBestMatch(mainString, targetStrings)](#findbestmatchmainstring-targetstrings)
17+
* [Arguments](#arguments-1)
18+
* [Returns](#returns-1)
19+
* [Examples](#examples-1)
1820
* [Release Notes](#release-notes)
19-
* [2.0.0](#200)
20-
* [3.0.0](#300)
21-
* [3.0.1](#301)
22-
* [4.0.0](#400)
21+
+ [2.0.0](#200)
22+
+ [3.0.0](#300)
23+
+ [3.0.1](#301)
24+
+ [4.0.1](#401)
2325

2426

2527
## Usage
@@ -44,9 +46,9 @@ var matches = stringSimilarity.findBestMatch('healed', ['edward', 'sealed', 'the
4446

4547
#### For browser apps
4648

47-
Include `<script>//unpkg.com/string-similarity/umd/string-similarity.min.js</script>` to get the latest version.
49+
Include `<script src="//unpkg.com/string-similarity/umd/string-similarity.min.js"></script>` to get the latest version.
4850

49-
Or `<script>//unpkg.com/string-similarity@3.0.0/umd/string-similarity.min.js</script>` to get a specific version (3.0.0) in this case.
51+
Or `<script src="//unpkg.com/string-similarity@4.0.1/umd/string-similarity.min.js"></script>` to get a specific version (4.0.1) in this case.
5052

5153
This exposes a global variable called `stringSimilarity` which you can start using.
5254

@@ -145,7 +147,7 @@ stringSimilarity.findBestMatch('Olive-green table for sale, in extremely good co
145147
* Refactoring: removed unused functions; used `substring` instead of `substr`
146148
* Updated dependencies
147149

148-
### 4.0.0
150+
### 4.0.1
149151
* Distributing as an UMD build to be used in browsers.
150152

151153
![Build status](https://codeship.com/projects/2aa453d0-0959-0134-8a76-4abcb29fe9b4/status?branch=master)

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
{
22
"name": "string-similarity",
3-
"version": "4.0.0",
3+
"version": "4.0.1",
44
"description": "Finds degree of similarity between strings, based on Dice's Coefficient, which is mostly better than Levenshtein distance.",
55
"main": "src/index.js",
66
"scripts": {
77
"test": "jasmine --config=src/spec/support/jasmine.json",
8-
"build": "rm -rf umd && webpack-cli"
8+
"build": "rm -rf umd && webpack-cli",
9+
"prepublish": "npm test && npm run build"
910
},
1011
"repository": {
1112
"type": "git",

0 commit comments

Comments
 (0)