Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 1.73 KB

README.md

File metadata and controls

52 lines (32 loc) · 1.73 KB
Raw

Strings2markdown

Gem Version Build Status Coverage Status

This gem is intended to generate the Reference part of puppet module's README.md.

Installation

Add this line to your puppet module's Gemfile:

gem 'strings2markdown'

and update your installation

bundle

Usage

TODO:

  • Write rake task.
  • Write documentation for the rake task.

Development

After checking out the repo, run bundle install to install dependencies. Then, run bundle exec rake spec to run the tests.

Or, you can run bin/simple_test to generate YAML representation of spec/fixtures/test_module documentation and see how this works internally.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pegasd/strings2markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Strings2markdown project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.