docs/file.README.html in dockerize_rails-1.2.1.beta.2 vs docs/file.README.html in dockerize_rails-1.2.1.beta.3
- old
+ new
@@ -64,26 +64,24 @@
src="https://img.shields.io/github/tag/eendroroy/dockerize_rails.svg"></a>
<a href="https://rubygems.org/gems/dockerize_rails"><img
src="https://badge.fury.io/rb/dockerize_rails.svg"></a> <a
href="https://rubygems.org/gems/dockerize_rails"><img
src="https://img.shields.io/gem/dt/dockerize_rails.svg"></a> <a
-href="https://travis-ci.org/eendroroy/dockerize_rails"><img
-src="https://travis-ci.org/eendroroy/dockerize_rails.svg?branch=master"></a>
-<a href="https://codeclimate.com/github/eendroroy/dockerize_rails"><img
-src="https://codeclimate.com/github/eendroroy/dockerize_rails/badges/gpa.svg"></a>
-<a href="CONTRIBUTORS.md"><img
+href="CONTRIBUTORS.md"><img
src="https://img.shields.io/github/contributors/eendroroy/dockerize_rails.svg"></a></p>
<h2 id="label-Installation">Installation</h2>
<p>Add this line to your rails application's Gemfile:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dockerize_rails</span><span class='tstring_end'>'</span></span>
</code></pre>
-<p>And then execute: <code>bash $ bundle </code></p>
+<p>And then execute:</p>
+<pre class="code ruby"><code class="ruby">$ bundle install</code></pre>
+
<h2 id="label-Usage">Usage</h2>
<p>First create the configuration file <code>.dockerize.yml</code> for the gem
itself. Run: <code>bundle exec dock configure</code> to generate the
template. Use <code>--tiny</code> option to skip the description of
@@ -107,52 +105,57 @@
<p>To remove docker configurations: <code>bundle exec dock undockerize</code>.
Use <code>--purge</code> option to remove <code>.dockerize.yml</code> file:
<code>bundle exec dock undockerize --purge</code></p>
-<p>All available commands: <code>bash $ bundle exec dock help $ bundle exec
-dock configure $ bundle exec dock configure --tiny $ bundle exec dock
-dockerize $ bundle exec dock dockerize --test-env $ bundle exec dock
-undockerize $ bundle exec dock undockerize --purge $ bundle exec dock
-docker_info $ bundle exec dock docker_pull $ bundle exec dock docker_build
-$ bundle exec dock docker_build --log $ bundle exec dock docker_build
---rebuild $ bundle exec dock docker_build --rebuild --force $ bundle exec
-dock docker_start $ bundle exec dock docker_stop $ bundle exec dock
-docker_stop --delete $ bundle exec dock docker_delete </code></p>
+<p>All available commands:</p>
-<p>Help message: “` Usage: dock <command> or: bundle exec dock
-<command></p>
+<pre class="code ruby"><code class="ruby">$ bundle exec dock help
+$ bundle exec dock configure [ --tiny ]
+$ bundle exec dock dockerize [ --test-env ]
+$ bundle exec dock undockerize [ --purge ]
+$ bundle exec dock docker_info
+$ bundle exec dock docker_pull
+$ bundle exec dock docker_build [ --log | --rebuild | --rebuild --force ]
+$ bundle exec dock docker_start
+$ bundle exec dock docker_stop [ --delete ]
+$ bundle exec dock docker_delete [ --force ]</code></pre>
-<p>commands:</p>
+<p>Help message:</p>
-<pre class="code ruby"><code class="ruby"> configure, c, rc, cr - Generates '.dockerize.yml'
- [--tiny] -- Generates shorter config file, skipping all descriptions
+<pre class="code ruby"><code class="ruby">Usage: dock <command>
+ or: bundle exec dock <command>
- dockerize, dc, d - Generates docker config files
- [--test-env] -- Generates configurations to run tests.
+ commands:
- undockerize, ud, du, u, dd - Removes docker configurations
- [--purge] -- Also removes .dockerize.yml
+ configure, c, rc, cr - Generates '.dockerize.yml'
+ [--tiny] -- Generates shorter config file, skipping all descriptions
- docker_info, info - Shows Docker information
- docker_pull, pull - Pulls base Docker images (ruby, mysql/postgres)
- docker_build, build - Builds Docker images
- [--log] -- Displays/Streams build log
- [--rebuild] -- Deletes images if exists and rebuilds
- [--force] -- Force Image deletion. Works only with --rebuild option
+ dockerize, dc, d - Generates docker config files
+ [--test-env] -- Generates configurations to run tests.
- docker_start, start - Run/Starts Docker containers
- docker_stop, stop - Stops Docker containers
- [--delete] -- Also deletes the containers
+ undockerize, ud, du, u, dd - Removes docker configurations
+ [--purge] -- Also removes .dockerize.yml
- docker_delete, delete - Deletes Docker containers
- help, h - Prints this message</code></pre>
+ docker_info, info - Shows Docker information
+ docker_pull, pull - Pulls base Docker images (ruby, mysql/postgres)
+ docker_build, build - Builds Docker images
+ [--log] -- Displays/Streams build log
+ [--rebuild] -- Deletes images if exists and rebuilds
+ [--force] -- Force Image deletion. Works only with --rebuild option
-<p>“`</p>
+ docker_start, start - Run/Starts Docker containers
+ docker_stop, stop - Stops Docker containers
+ [--delete] -- Also deletes the containers
-<h2 id="label-Demo">Demo</h2>
+ docker_delete, delete - Deletes Docker containers
+ [--force] -- Force Container deletion.
+ help, h - Prints this message</code></pre>
+
+<h2 id="label-Demonstration">Demonstration</h2>
+
<p><a href="https://asciinema.org/a/121552"><img
src="https://asciinema.org/a/121552.png"></a></p>
<h2 id="label-Development">Development</h2>
@@ -179,10 +182,10 @@
href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feendroroy%2Fdockerize_rails?ref=badge_large"><img
src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feendroroy%2Fdockerize_rails.svg?type=large"></a></p>
</div></div>
<div id="footer">
- Generated on Sat Aug 12 16:08:38 2017 by
+ Generated on Sat Aug 12 16:57:24 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.1.0).
</div>
</div>
\ No newline at end of file