update readme

README.md

@@ -17,10 +17,10 @@ The [complete API documentation](https://olivierbinette.github.io/StringCompare/
 
 ## Installation
 
-Install the development version from github using the following commands:
+Install the released version from github using the following commands:
 
 ```bash
-    pip install git+https://github.com/OlivierBinette/StringCompare.git
+    pip install git+https://github.com/OlivierBinette/StringCompare.git@release
 ```
 
 ## Project Roadmap
@@ -115,9 +115,9 @@ print(tabulate(table, headers=["Package", "avg runtime (ns)"]))
 
     Package          avg runtime (ns)
     -------------  ------------------
-    StringCompare             703.727
-    jellyfish                 978.144
-    textdistance             4139.59
+    StringCompare             697.834
+    jellyfish                 974.363
+    textdistance             3982.73
 
 
 ### Performance notes

docs/README.html

@@ -94,8 +94,8 @@ <h1>⚡ <strong>StringCompare</strong>: Efficient String Comparison Functions<a
 <p>The <a class="reference external" href="https://olivierbinette.github.io/StringCompare/source/stringcompare.html">complete API documentation</a> is available on the project website <a class="reference external" href="https://olivierbinette.github.io/StringCompare">olivierbinette.github.io/StringCompare</a>.</p>
 <section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
-<p>Install the development version from github using the following commands:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install git+https://github.com/OlivierBinette/StringCompare.git
+<p>Install the released version from github using the following commands:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install git+https://github.com/OlivierBinette/StringCompare.git@release
 </pre></div>
 </div>
 </section>
@@ -190,9 +190,9 @@ <h2>Benchmark<a class="headerlink" href="#benchmark" title="Permalink to this he
 </div>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Package</span>          <span class="n">avg</span> <span class="n">runtime</span> <span class="p">(</span><span class="n">ns</span><span class="p">)</span>
 <span class="o">-------------</span>  <span class="o">------------------</span>
-<span class="n">StringCompare</span>             <span class="mf">703.727</span>
-<span class="n">jellyfish</span>                 <span class="mf">978.144</span>
-<span class="n">textdistance</span>             <span class="mf">4139.59</span>
+<span class="n">StringCompare</span>             <span class="mf">697.834</span>
+<span class="n">jellyfish</span>                 <span class="mf">974.363</span>
+<span class="n">textdistance</span>             <span class="mf">3982.73</span>
 </pre></div>
 </div>
 <section id="performance-notes">

docs/_sources/README.rst.txt

@@ -45,11 +45,11 @@ The `complete API documentation <https://olivierbinette.github.io/StringCompare/
 Installation
 ------------
 
-Install the development version from github using the following commands:
+Install the released version from github using the following commands:
 
 .. code-block:: bash
 
-       pip install git+https://github.com/OlivierBinette/StringCompare.git
+       pip install git+https://github.com/OlivierBinette/StringCompare.git@release
 
 Project Roadmap
 ---------------
@@ -155,9 +155,9 @@ Comparison of the Damerau-Levenshtein implementation speed for different Python
 
    Package          avg runtime (ns)
    -------------  ------------------
-   StringCompare             703.727
-   jellyfish                 978.144
-   textdistance             4139.59
+   StringCompare             697.834
+   jellyfish                 974.363
+   textdistance             3982.73
 
 
 

docs/index.html

@@ -81,8 +81,8 @@ <h1>⚡ <strong>StringCompare</strong>: Efficient String Comparison Functions<a
 <p>The <a class="reference external" href="https://olivierbinette.github.io/StringCompare/source/stringcompare.html">complete API documentation</a> is available on the project website <a class="reference external" href="https://olivierbinette.github.io/StringCompare">olivierbinette.github.io/StringCompare</a>.</p>
 <section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
-<p>Install the development version from github using the following commands:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install git+https://github.com/OlivierBinette/StringCompare.git
+<p>Install the released version from github using the following commands:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install git+https://github.com/OlivierBinette/StringCompare.git@release
 </pre></div>
 </div>
 </section>
@@ -177,9 +177,9 @@ <h2>Benchmark<a class="headerlink" href="#benchmark" title="Permalink to this he
 </div>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Package</span>          <span class="n">avg</span> <span class="n">runtime</span> <span class="p">(</span><span class="n">ns</span><span class="p">)</span>
 <span class="o">-------------</span>  <span class="o">------------------</span>
-<span class="n">StringCompare</span>             <span class="mf">703.727</span>
-<span class="n">jellyfish</span>                 <span class="mf">978.144</span>
-<span class="n">textdistance</span>             <span class="mf">4139.59</span>
+<span class="n">StringCompare</span>             <span class="mf">697.834</span>
+<span class="n">jellyfish</span>                 <span class="mf">974.363</span>
+<span class="n">textdistance</span>             <span class="mf">3982.73</span>
 </pre></div>
 </div>
 <section id="performance-notes">