From f83ba3cd7bae874c20c429774e911ae8cff8bced Mon Sep 17 00:00:00 2001 From: Akash K Date: Thu, 2 Jan 2020 19:30:02 +0000 Subject: [PATCH] readme changes --- README.md | 32 +++++++++++++++++--------------- package-lock.json | 2 +- package.json | 5 +++-- 3 files changed, 21 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 4e3ec79..f8d95ab 100644 --- a/README.md +++ b/README.md @@ -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 @@ -44,9 +46,9 @@ var matches = stringSimilarity.findBestMatch('healed', ['edward', 'sealed', 'the #### For browser apps -Include `` to get the latest version. +Include `` to get the latest version. -Or `` to get a specific version (3.0.0) in this case. +Or `` to get a specific version (4.0.1) in this case. This exposes a global variable called `stringSimilarity` which you can start using. @@ -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) diff --git a/package-lock.json b/package-lock.json index 0f2526a..03b4399 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "string-similarity", - "version": "4.0.0", + "version": "4.0.1", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index e6931db..7030da5 100644 --- a/package.json +++ b/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",