Merge pull request #37 from voxpupuli/cleanup

Cleanup docs and gemspec

README.md

@@ -2,9 +2,9 @@
 
 Beaker library to use docker hypervisor
 
-# How to use this wizardry
+## How to use this wizardry
 
-This gem that allows you to use hosts with [docker](docker.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker).
+This gem that allows you to use hosts with [docker](docker.md) hypervisor with [beaker](https://github.com/voxpupuli/beaker).
 
 Beaker will automatically load the appropriate hypervisors for any given hosts
 file, so as long as your project dependencies are satisfied there's nothing else
@@ -14,20 +14,20 @@ In order to use a specific hypervisor or DSL extension library in your project,
 you will need to include them alongside Beaker in your Gemfile or
 project.gemspec. E.g.
 
-~~~ruby
+```ruby
 # Gemfile
 gem 'beaker', '~> 4.0'
 gem 'beaker-docker'
 # project.gemspec
 s.add_runtime_dependency 'beaker', '~> 4.0'
 s.add_runtime_dependency 'beaker-docker'
-~~~
+```
 
-## Nodeset Options
+### Nodeset Options
 
 The following is a sample nodeset:
 
-~~~yaml
+```yaml
 HOSTS:
   el8:
     platform: el-8-x86_64
@@ -51,33 +51,33 @@ HOSTS:
 CONFIG:
   docker_cap_add:
     - AUDIT_WRITE
-~~~
+```
 
-## Privileged containers
+### Privileged containers
 
-Containers are **not** run in privileged mode by default for safety.
+Containers are run in privileged mode by default unless capabilities are set.
 
-If you wish to enable privileged mode, simply set the following in your node:
+If you wish to disable privileged mode, simply set the following in your node:
 
-~~~yaml
+```yaml
 dockeropts:
   HostConfig:
-    Privileged: true
-~~~
+    Privileged: false
+```
 
-## Cleaning up after tests
+### Cleaning up after tests
 
 Containers created by this plugin may not be destroyed unless the tests complete
 successfully. Each container created is prefixed by `beaker-` to make filtering
 for clean up easier.
 
 A quick way to clean up all nodes is as follows:
 
-~~~sh
+```sh
 podman rm -f $( podman ps -q -f name="beaker-*" )
-~~~
+```
 
-# Working with `podman`
+## Working with `podman`
 
 If you're using a version of `podman` that has API socket support then you
 should be able to simply set `DOCKER_HOST` to your socket and connect as usual.
@@ -94,32 +94,26 @@ See the
 [HostConfig](https://any-api.com/docker_com/engine/docs/Definitions/HostConfig)
 portion of the docker API for more information.
 
-# Spec tests
+## Spec tests
 
 Spec test live under the `spec` folder. There are the default rake task and therefore can run with a simple command:
+
 ```bash
 bundle exec rake test:spec
 ```
 
-# Acceptance tests
+## Acceptance tests
 
 There is a simple rake task to invoke acceptance test for the library:
 
 ```bash
 bundle exec rake test:acceptance
 ```
 
-# Contributing
+## Contributing
 
 Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide.
 
-# Releasing
-
-To release new versions of beaker-docker, please use this [jenkins job](https://cinext-jenkinsmaster-sre-prod-1.delivery.puppetlabs.net/view/all/job/qe_beaker-docker_init-multijob_master/). This job
-lives on Puppet-internal infrastructure, so you'll need to be a part of the Puppet org to do this.
+## Releasing
 
-To run the job, click on `Build with Parameters` in the menu on the left. Make
-sure you check the box next to `PUBLIC` and enter the appropriate version. The
-version should adhere to [semantic version standards](https://semver.org).
-When in doubt, consult the [maintainers of Beaker](https://github.com/puppetlabs/beaker/blob/master/CODEOWNERS)
-for guidance.
+To release new versions of beaker-docker, please use update `lib/beaker-docker/version.rb` with the new version number. The version should adhere to [semantic version standards](https://semver.org). When in doubt, ask in the `#voxpupuli` channel of the Puppet community Slack or in `#voxpupuli` on irc.freenode.net ([Webinterface](https://webchat.freenode.net/?channels=%23voxpupuli)).

beaker-docker.gemspec

@@ -5,12 +5,17 @@ require 'beaker-docker/version'
 Gem::Specification.new do |s|
   s.name        = "beaker-docker"
   s.version     = BeakerDocker::VERSION
-  s.authors     = ["Rishi Javia, Kevin Imber, Tony Vu"]
-  s.email       = ["rishi.javia@puppet.com, kevin.imber@puppet.com, tony.vu@puppet.com"]
-  s.homepage    = "https://github.com/puppetlabs/beaker-docker"
+  s.authors     = [
+    "Vox Pupuli",
+    "Rishi Javia",
+    "Kevin Imber",
+    "Tony Vu"
+  ]
+  s.email       = ["voxpupuli@groups.io"]
+  s.homepage    = "https://github.com/voxpupuli/beaker-docker"
   s.summary     = %q{Beaker DSL Extension Helpers!}
   s.description = %q{For use for the Beaker acceptance testing tool}
-  s.license     = 'Apache2'
+  s.license     = 'Apache-2.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -19,10 +24,10 @@ Gem::Specification.new do |s|
 
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'rspec-its', '~> 1.3'
   s.add_development_dependency 'fakefs', '~> 1.3'
   s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov', '~> 0.18'
   s.add_development_dependency 'pry', '~> 0.10'
 
   # Run time dependencies