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

Commit

Permalink
readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
aceakash committed Jan 2, 2020
1 parent 68da344 commit f83ba3c
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 18 deletions.
32 changes: 17 additions & 15 deletions README.md
Expand Up @@ -6,20 +6,22 @@ Finds degree of similarity between two strings, based on [Dice's Coefficient](ht
## Table of Contents

* [Usage](#usage)
+ [For Node.js](#for-nodejs)
+ [For browser apps](#for-browser-apps)
* [API](#api)
* [compareTwoStrings(string1, string2)](#comparetwostringsstring1-string2)
* [Arguments](#arguments)
* [Returns](#returns)
* [Examples](#examples)
* [findBestMatch(mainString, targetStrings)](#findbestmatchmainstring-targetstrings)
* [Arguments](#arguments-1)
* [Returns](#returns-1)
* [Examples](#examples-1)
+ [compareTwoStrings(string1, string2)](#comparetwostringsstring1-string2)
* [Arguments](#arguments)
* [Returns](#returns)
* [Examples](#examples)
+ [findBestMatch(mainString, targetStrings)](#findbestmatchmainstring-targetstrings)
* [Arguments](#arguments-1)
* [Returns](#returns-1)
* [Examples](#examples-1)
* [Release Notes](#release-notes)
* [2.0.0](#200)
* [3.0.0](#300)
* [3.0.1](#301)
* [4.0.0](#400)
+ [2.0.0](#200)
+ [3.0.0](#300)
+ [3.0.1](#301)
+ [4.0.1](#401)


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

#### For browser apps

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

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.
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.

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

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

### 4.0.0
### 4.0.1
* Distributing as an UMD build to be used in browsers.

![Build status](https://codeship.com/projects/2aa453d0-0959-0134-8a76-4abcb29fe9b4/status?branch=master)
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
@@ -1,11 +1,12 @@
{
"name": "string-similarity",
"version": "4.0.0",
"version": "4.0.1",
"description": "Finds degree of similarity between strings, based on Dice's Coefficient, which is mostly better than Levenshtein distance.",
"main": "src/index.js",
"scripts": {
"test": "jasmine --config=src/spec/support/jasmine.json",
"build": "rm -rf umd && webpack-cli"
"build": "rm -rf umd && webpack-cli",
"prepublish": "npm test && npm run build"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit f83ba3c

Please sign in to comment.