README.adoc in puma-daemon-0.3.2 vs README.adoc in puma-daemon-0.5.0

- old
+ new

@@ -8,25 +8,27 @@ |=== |Badge |Type +|Sponsor! +|image:https://img.shields.io/liberapay/goal/kigster.svg?logo=liberapay[link=https://liberapay.com/kigster/donate,width="150"] + |Test Suite -|image:https://github.com/kigster/puma-daemon/workflows/Ruby/badge.svg[link=https://github.com/kigster/puma-daemon/actions?query=workflow%3ARuby,width="150"] +|image:https://github.com/kigster/puma-daemon/actions/workflows/main.yml/badge.svg[link=https://github.com/kigster/puma-daemon/actions?query=workflow%3ARuby,width="150"] - |Licensing -|image:https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkigster%2Fpuma-daemon.svg?type=shield[link=https://app.fossa.com/projects/git%2Bgithub.com%2Fkigster%2Fpuma-daemon?ref=badge_shield,width="190"] +|image:https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkigster%2Fpuma-daemon.svg?type=shield[link=https://app.fossa.com/projects/git%2Bgithub.com%2Fkigster%2Fpuma-daemon?ref=badge_shield,width="150",height="100"] image:https://app.fossa.io/api/projects/custom%2B19655%2Fgithub.com%2Fkigster%2Fpuma-daemon.svg[FOSSA Status,link=https://app.fossa.io/projects/custom%2B19655%2Fgithub.com%2Fkigster%2Fpuma-daemon?ref=badge_large&issueType=license] |Gem Version -|image:https://badge.fury.io/rb/puma-daemon.svg["Gem Version",link="https://badge.fury.io/rb/puma-daemon",width="220s"] +|image:https://badge.fury.io/rb/puma-daemon.svg["Gem Version",link="https://badge.fury.io/rb/puma-daemon",width="150",height="50"] |Test Coverage -|image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graph/badge.svg?token=asxarMSGbz[link=https://codecov.io/gh/kigster/puma-daemon,width="220"] +|image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graph/badge.svg?token=asxarMSGbz[link=https://codecov.io/gh/kigster/puma-daemon,width="150",height="50"] |Coverage Areas -|image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graphs/sunburst.svg?token=asxarMSGbz[sunbirst,width="30%",link=https://codecov.io/gh/kigster/puma-daemon,float=left] image:https://codecov.io/gh/kigster/puma-daemon/branch/master/graphs/icicle.svg?token=asxarMSGbz[coverage-graph,width="60%",link=https://codecov.io/gh/kigster/puma-daemon,float=right] +|image:https://codecov.io/gh/kigster/puma-daemon/graphs/sunburst.svg?token=asxarMSGbz[coverage-graph,width="200",link=https://codecov.io/gh/kigster/puma-daemon] |=== NOTE: You can read this in a nicely formatted https://github.com/kigster/puma-daemon/blob/master/README.pdf[README.pdf] document. @@ -218,9 +220,40 @@ * To install this gem onto your local machine, run `bundle exec rake install`. * To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to https://rubygems.org[rubygems.org]. Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/puma-daemon. + +== Using the `Makefile` + +The project has a Makefile to assist in running multi-step commmands. + +Run `make` without arguments to see available targets: + +``` +❯ make +ci Run all checks run on CI +clean Clean-up +docker-build-ruby Builds the Docker image by compiling ruby 3.0.0 +docker-build-run Drops you into a BASH session on ubuntu with ruby 3.0.0 +docker-download-ruby Builds the Docker image by downloading ruby 3.0.0 image +docker-download-run Drops you into a BASH session on ubuntu with ruby 3.0.0 +generate-pdf Regenerates README,pdf from README.adoc +help Prints help message auto-generated from the comments. +puma-v5 Installs puma 5.0.0 +puma-v6 Installs puma 5.0.0 +rubocop Run rubocop +tag-update Re-tag latest codebase with the existing version +tag Tag with the latest .version +test-all Test all supported Puma Versions +``` + +You can experiement with these, but perhaps the most useful you'll find the following: + + * ci — runs all tests for all puma versions and then runs rubocop + * generate-pdf — regen PDF from README + + == License The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].