v1.0.1 (#2)

* added dashed option * improved docs
ElixirCL · Apr 11, 2022 · 31f5c20 · 31f5c20
1 parent 3201b69
commit 31f5c20
Show file tree

Hide file tree

Showing 27 changed files with 363 additions and 223 deletions.
diff --git a/EXAMPLES.livemd b/EXAMPLES.livemd
@@ -56,10 +56,29 @@ ElixirCLRut.valid?("1-9")
 ## format
 
 You can quickly get the format.
+This will append the correct digit if not available.
 
 ```elixir
 # "6.300.948-2"
-ElixirCLRut.format("6,3.0.0,9.48 -2....")
+ElixirCLRut.format("6,3.0.0,9.48....")
+```
+
+You can specify if the rut has the check digit by
+using `format/2` or dashing the digit.
+
+```elixir
+# "6.300.948-2"
+ElixirCLRut.format("6300948-2")
+ElixirCLRut.format("63009482", true)
+```
+
+You can also specify if the rut has the check digit by
+using `dashed?:true` and the separator character
+by passing `separator:` params.
+
+```elixir
+# "6,300,948-2"
+ElixirCLRut.format("63009482", dashed?:true, separator: ",")
 ```
 
 ## from

diff --git a/docs/.build b/docs/.build
@@ -17,8 +17,8 @@ dist/html/fonts/remixicon.svg
 dist/html/fonts/remixicon.ttf
 dist/html/fonts/remixicon.woff
 dist/html/fonts/remixicon.woff2
-dist/search_items-a54bfee70c.js
-dist/sidebar_items-d517de2ccf.js
+dist/search_items-ecd991a5fa.js
+dist/sidebar_items-733cc52ca5.js
 examples.html
 index.html
 license.html

diff --git a/docs/404.html b/docs/404.html
@@ -5,14 +5,14 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.28.3">
-    <meta name="project" content="ElixirCLRUT v1.0.0">
+    <meta name="project" content="ElixirCLRUT v1.0.1">
 
       <meta name="author" content="AUTHORS.md">
 
-    <title>404 — ElixirCLRUT v1.0.0</title>
+    <title>404 — ElixirCLRUT v1.0.1</title>
     <link rel="stylesheet" href="dist/elixir-d5ff82e6b0f5651c0ac0.css" />
 
-    <script src="dist/sidebar_items-d517de2ccf.js"></script>
+    <script src="dist/sidebar_items-733cc52ca5.js"></script>
 
       <script src="docs_config.js"></script>
 
@@ -68,7 +68,7 @@
 ElixirCLRUT
       </a>
       <strong class="sidebar-projectVersion" translate="no">
-        v1.0.0
+        v1.0.1
       </strong>
     </div>
     <ul class="sidebar-listNav">
@@ -109,8 +109,8 @@ <h1>
             On Hex.pm:
 
             <span class="line">
-              <a href="https://hex.pm/packages/elixircl_rut/1.0.0" class="line footer-hex-package">Package</a>
-              <a href="https://preview.hex.pm/preview/elixircl_rut/1.0.0" class="line">Preview</a>
+              <a href="https://hex.pm/packages/elixircl_rut/1.0.1" class="line footer-hex-package">Package</a>
+              <a href="https://preview.hex.pm/preview/elixircl_rut/1.0.1" class="line">Preview</a>
 
             </span>
 

diff --git a/docs/ElixirCLRUT.epub b/docs/ElixirCLRUT.epub
diff --git a/docs/ElixirCLRut.CheckDigit.html b/docs/ElixirCLRut.CheckDigit.html
@@ -5,14 +5,14 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.28.3">
-    <meta name="project" content="ElixirCLRUT v1.0.0">
+    <meta name="project" content="ElixirCLRUT v1.0.1">
 
       <meta name="author" content="AUTHORS.md">
 
-    <title>ElixirCLRut.CheckDigit — ElixirCLRUT v1.0.0</title>
+    <title>ElixirCLRut.CheckDigit — ElixirCLRUT v1.0.1</title>
     <link rel="stylesheet" href="dist/elixir-d5ff82e6b0f5651c0ac0.css" />
 
-    <script src="dist/sidebar_items-d517de2ccf.js"></script>
+    <script src="dist/sidebar_items-733cc52ca5.js"></script>
 
       <script src="docs_config.js"></script>
 
@@ -68,7 +68,7 @@
 ElixirCLRUT
       </a>
       <strong class="sidebar-projectVersion" translate="no">
-        v1.0.0
+        v1.0.1
       </strong>
     </div>
     <ul class="sidebar-listNav">
@@ -101,7 +101,7 @@ <h1>
     </a>
 
   <span translate="no">ElixirCLRut.CheckDigit</span> 
-  <small class="app-vsn" translate="no">(ElixirCLRUT v1.0.0)</small>
+  <small class="app-vsn" translate="no">(ElixirCLRUT v1.0.1)</small>
 
 </h1>
 
@@ -195,7 +195,7 @@ <h1 class="signature" translate="no">get(normalized)</h1>
   </a>
   Examples
 </h2>
-<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">get</span><span class="p" data-group-id="4323800302-1">(</span><span class="p" data-group-id="4323800302-2">[</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">8</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">0</span><span class="p" data-group-id="4323800302-2">]</span><span class="p" data-group-id="4323800302-1">)</span><span class="w">
+<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">get</span><span class="p" data-group-id="7796507211-1">(</span><span class="p" data-group-id="7796507211-2">[</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">8</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">0</span><span class="p" data-group-id="7796507211-2">]</span><span class="p" data-group-id="7796507211-1">)</span><span class="w">
 </span><span class="s">&quot;6&quot;</span></code></pre>
   </section>
 </section>
@@ -233,8 +233,8 @@ <h1 class="signature" translate="no">remove(normalized)</h1>
   </a>
   Examples
 </h2>
-<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">remove</span><span class="p" data-group-id="7608889388-1">(</span><span class="p" data-group-id="7608889388-2">[</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">8</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">6</span><span class="p" data-group-id="7608889388-2">]</span><span class="p" data-group-id="7608889388-1">)</span><span class="w">
-</span><span class="p" data-group-id="7608889388-3">[</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">8</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">0</span><span class="p" data-group-id="7608889388-3">]</span></code></pre>
+<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">remove</span><span class="p" data-group-id="3877349787-1">(</span><span class="p" data-group-id="3877349787-2">[</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">8</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">6</span><span class="p" data-group-id="3877349787-2">]</span><span class="p" data-group-id="3877349787-1">)</span><span class="w">
+</span><span class="p" data-group-id="3877349787-3">[</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">8</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">0</span><span class="p" data-group-id="3877349787-3">]</span></code></pre>
   </section>
 </section>
 
@@ -247,10 +247,10 @@ <h1 class="signature" translate="no">remove(normalized)</h1>
             On Hex.pm:
 
             <span class="line">
-              <a href="https://hex.pm/packages/elixircl_rut/1.0.0" class="line footer-hex-package">Package</a>
-              <a href="https://preview.hex.pm/preview/elixircl_rut/1.0.0" class="line">Preview</a>
+              <a href="https://hex.pm/packages/elixircl_rut/1.0.1" class="line footer-hex-package">Package</a>
+              <a href="https://preview.hex.pm/preview/elixircl_rut/1.0.1" class="line">Preview</a>
 
-                <a href="https://preview.hex.pm/preview/elixircl_rut/1.0.0/show/lib/checkdigit.ex">(current file)</a>
+                <a href="https://preview.hex.pm/preview/elixircl_rut/1.0.1/show/lib/checkdigit.ex">(current file)</a>
 
             </span>