docs - update

README.md

@@ -56,7 +56,7 @@ db.query "select id, created_at, email from users" do |rs|
 end
 
 # Closes all connections of this DB entry point and remove it.
-db.destroy("app")
+DBX.destroy("app")
 ```
 
 Model example:
@@ -93,7 +93,7 @@ pp user
 
 ### Development
 
-1. You only need Git, Docker and Docker-composer installed on your machine.
+1. You only need Git, Docker and Docker-compose installed on your machine.
 2. Clone this repo and run `./scripts/prepare`.
 3. Run first `docker-compose up`, then `./scripts/just dev-spec`).
 4. Check the project before committing or pushing: `./scripts/check`

docs/DBX.html

@@ -112,7 +112,7 @@ <h2>
 <span class="k">end</span>
 
 <span class="c"># Closes all connections of this DB entry point and remove this DB entry point.</span>
-db.destroy(<span class="s">&quot;app&quot;</span>)</code></pre>
+<span class="t">DBX</span>.destroy(<span class="s">&quot;app&quot;</span>)</code></pre>
 
 <p>Model:</p>
 
@@ -161,6 +161,13 @@ <h2>
     Defined in:
   </h2>
 
+
+      <a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L59" target="_blank">
+        dbx.cr
+      </a>
+
+    <br/>
+
 
 
 
@@ -281,6 +288,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L81" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -300,6 +309,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L76" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -319,6 +330,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L71" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -338,6 +351,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L66" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -358,6 +373,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L101" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -377,6 +394,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L109" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -399,6 +418,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L89" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -418,6 +439,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L126" target="_blank">View source</a>]
+
       </div>
     </div>
 
@@ -438,6 +461,8 @@ <h2>
       <br/>
       <div>
 
+          [<a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L121" target="_blank">View source</a>]
+
       </div>
     </div>
 

docs/DBX/DBHashType.html

@@ -115,6 +115,13 @@ <h2>
     Defined in:
   </h2>
 
+
+      <a href="https://github.com/Nicolab/crystal-dbx/blob/eec21ae2a9bb78dde89d171f8634f5767bf7055b/src/dbx.cr#L60" target="_blank">
+        dbx.cr
+      </a>
+
+    <br/>
+
 
 
 

docs/index.html

@@ -79,6 +79,8 @@ <h1><a id="dbx" class="anchor" href="#dbx">
   </svg>
 </a>DBX</h1>
 
+<p><a href="https://github.com/Nicolab/crystal-dbx/actions" target="_blank"><img src="https://github.com/Nicolab/crystal-dbx/workflows/CI/badge.svg?branch=master" alt="CI Status"/></a> <a href="https://github.com/Nicolab/crystal-dbx/releases" target="_blank"><img src="https://img.shields.io/github/release/Nicolab/crystal-dbx.svg" alt="GitHub release"/></a> <a href="https://nicolab.github.io/crystal-dbx/" target="_blank"><img src="https://img.shields.io/badge/docs-available-brightgreen.svg" alt="Docs"/></a></p>
+
 <p><code><a href="DBX.html">DBX</a></code> is a very small module (no overhead) for <a href="https://crystal-lang.org" target="_blank">Crystal lang</a>. <code><a href="DBX.html">DBX</a></code> adds multi-connection support to the database and useful helpers.</p>
 
 <p><code><a href="DBX.html">DBX</a></code> uses the common <a href="https://github.com/crystal-lang/crystal-db" target="_blank">crystal-db</a> API for Crystal. You will need to have a specific driver to access a database.</p>
@@ -138,7 +140,7 @@ <h2><a id="usage" class="anchor" href="#usage">
 end
 
 # Closes all connections of this DB entry point and remove it.
-db.destroy("app")</code></pre>
+DBX.destroy("app")</code></pre>
 
 <p>Model example:</p>
 
@@ -175,7 +177,7 @@ <h3><a id="development" class="anchor" href="#development">
   </svg>
 </a>Development</h3>
 
-<ol><li>You only need Git, Docker and Docker-composer installed on your machine.</li><li>Clone this repo and run <code>./scripts/prepare</code>.</li><li>Run first <code>docker-compose up</code>, then <code>./scripts/just dev-spec</code>).</li><li>Check the project before committing or pushing: <code>./scripts/check</code></li></ol>
+<ol><li>You only need Git, Docker and Docker-compose installed on your machine.</li><li>Clone this repo and run <code>./scripts/prepare</code>.</li><li>Run first <code>docker-compose up</code>, then <code>./scripts/just dev-spec</code>).</li><li>Check the project before committing or pushing: <code>./scripts/check</code></li></ol>
 
 <p>It's just Docker and docker-compose, you can directly type the commands Docker and docker-compose if you prefer.</p>
 

src/dbx.cr

@@ -28,7 +28,7 @@ require "db"
 # end
 #
 # # Closes all connections of this DB entry point and remove this DB entry point.
-# db.destroy("app")
+# DBX.destroy("app")
 # ```
 #
 # Model: