Improve README

Mentioning semantic versioning and the CHANGELOG.md file.
lucaong · May 6, 2022 · 646e0df · 646e0df
1 parent acb5866
commit 646e0df
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,10 @@ and more background about `MiniSearch`, including a comparison with other
 similar libraries, in [this blog
 post](https://lucaongaro.eu/blog/2019/01/30/minisearch-client-side-fulltext-search-engine.html).
 
+`MiniSearch` follows [semantic versioning](https://semver.org/spec/v2.0.0.html),
+and documents releases and changes in the
+[changelog](https://github.com/lucaong/minisearch/blob/master/CHANGELOG.md).
+
 
 ## Use case
 

diff --git a/docs/classes/_minisearch_.minisearch.html b/docs/classes/_minisearch_.minisearch.html
@@ -189,7 +189,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L378">MiniSearch.ts:378</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L378">MiniSearch.ts:378</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -277,7 +277,7 @@ <h3>document<wbr>Count</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L873">MiniSearch.ts:873</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L873">MiniSearch.ts:873</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -302,7 +302,7 @@ <h3>add</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L480">MiniSearch.ts:480</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L480">MiniSearch.ts:480</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -333,7 +333,7 @@ <h3>add<wbr>All</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L514">MiniSearch.ts:514</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L514">MiniSearch.ts:514</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -364,7 +364,7 @@ <h3>add<wbr>All<wbr>Async</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L529">MiniSearch.ts:529</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L529">MiniSearch.ts:529</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -410,7 +410,7 @@ <h3>auto<wbr>Suggest</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L845">MiniSearch.ts:845</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L845">MiniSearch.ts:845</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -489,7 +489,7 @@ <h3>remove</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L563">MiniSearch.ts:563</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L563">MiniSearch.ts:563</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -528,7 +528,7 @@ <h3>remove<wbr>All</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L611">MiniSearch.ts:611</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L611">MiniSearch.ts:611</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -563,7 +563,7 @@ <h3>search</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L765">MiniSearch.ts:765</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L765">MiniSearch.ts:765</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -715,7 +715,7 @@ <h3>toJSON</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L1106">MiniSearch.ts:1106</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L1106">MiniSearch.ts:1106</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -755,7 +755,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Default</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L926">MiniSearch.ts:926</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L926">MiniSearch.ts:926</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -801,7 +801,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> loadJSON</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/MiniSearch.ts#L898">MiniSearch.ts:898</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/MiniSearch.ts#L898">MiniSearch.ts:898</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/_searchablemap_searchablemap_.searchablemap.html b/docs/classes/_searchablemap_searchablemap_.searchablemap.html
@@ -153,7 +153,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L31">SearchableMap/SearchableMap.ts:31</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L31">SearchableMap/SearchableMap.ts:31</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -191,7 +191,7 @@ <h3>size</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L207">SearchableMap/SearchableMap.ts:207</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L207">SearchableMap/SearchableMap.ts:207</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -218,7 +218,7 @@ <h3>[<wbr>Symbol.iterator]</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L286">SearchableMap/SearchableMap.ts:286</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L286">SearchableMap/SearchableMap.ts:286</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -242,7 +242,7 @@ <h3>at<wbr>Prefix</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L74">SearchableMap/SearchableMap.ts:74</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L74">SearchableMap/SearchableMap.ts:74</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -295,7 +295,7 @@ <h3>clear</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L97">SearchableMap/SearchableMap.ts:97</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L97">SearchableMap/SearchableMap.ts:97</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -319,7 +319,7 @@ <h3>delete</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L106">SearchableMap/SearchableMap.ts:106</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L106">SearchableMap/SearchableMap.ts:106</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -352,7 +352,7 @@ <h3>entries</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L115">SearchableMap/SearchableMap.ts:115</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L115">SearchableMap/SearchableMap.ts:115</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -377,7 +377,7 @@ <h3>fetch</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L262">SearchableMap/SearchableMap.ts:262</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L262">SearchableMap/SearchableMap.ts:262</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -432,7 +432,7 @@ <h3>for<wbr>Each</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L123">SearchableMap/SearchableMap.ts:123</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L123">SearchableMap/SearchableMap.ts:123</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -489,7 +489,7 @@ <h3>fuzzy<wbr>Get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L157">SearchableMap/SearchableMap.ts:157</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L157">SearchableMap/SearchableMap.ts:157</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -547,7 +547,7 @@ <h3>get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L167">SearchableMap/SearchableMap.ts:167</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L167">SearchableMap/SearchableMap.ts:167</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -582,7 +582,7 @@ <h3>has</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L177">SearchableMap/SearchableMap.ts:177</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L177">SearchableMap/SearchableMap.ts:177</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -616,7 +616,7 @@ <h3>keys</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L186">SearchableMap/SearchableMap.ts:186</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L186">SearchableMap/SearchableMap.ts:186</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -641,7 +641,7 @@ <h3>set</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L196">SearchableMap/SearchableMap.ts:196</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L196">SearchableMap/SearchableMap.ts:196</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -681,7 +681,7 @@ <h3>update</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L238">SearchableMap/SearchableMap.ts:238</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L238">SearchableMap/SearchableMap.ts:238</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -748,7 +748,7 @@ <h3>values</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L279">SearchableMap/SearchableMap.ts:279</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L279">SearchableMap/SearchableMap.ts:279</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -773,7 +773,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L296">SearchableMap/SearchableMap.ts:296</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L296">SearchableMap/SearchableMap.ts:296</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -811,7 +811,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Object</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/66521d3/src/SearchableMap/SearchableMap.ts#L310">SearchableMap/SearchableMap.ts:310</a></li>
+									<li>Defined in <a href="https://github.com/lucaong/minisearch/blob/f9cdc1f/src/SearchableMap/SearchableMap.ts#L310">SearchableMap/SearchableMap.ts:310</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/examples/billboard_1965-2015.json.gz b/docs/examples/billboard_1965-2015.json.gz
diff --git a/docs/index.html b/docs/index.html
@@ -78,6 +78,9 @@ <h1>MiniSearch</h1>
 					and more background about <code>MiniSearch</code>, including a comparison with other
 					similar libraries, in <a href="https://lucaongaro.eu/blog/2019/01/30/minisearch-client-side-fulltext-search-engine.html">this blog
 				post</a>.</p>
+				<p><code>MiniSearch</code> follows <a href="https://semver.org/spec/v2.0.0.html">semantic versioning</a>,
+					and documents releases and changes in the
+				<a href="https://github.com/lucaong/minisearch/blob/master/CHANGELOG.md">changelog</a>.</p>
 				<a href="#use-case" id="use-case" style="color: inherit; text-decoration: none;">
 					<h2>Use case</h2>
 				</a>