README.md

Resumer

Resumer is a Ruby tool that processes resumes written in machine-readable YAML format and produces a well-formatted version in either HTML or PDF.

It was initially inspired by JSON Resume but I though YAML would be a more human-readable format for this purpose.

Under the hood, Resumer uses the commander gem, and produces PDF files using wkhtmltopdf, which must be already installed in the system.

Installation

Add this line to your application's Gemfile:

gem 'resumer'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install resumer

Usage

Create a new YAML resume file:

$ resumer init [path/to/new/resume.yml]

Edit the YAML file with your data, then export it:

$ resumer export <sourceFile> [destFile/defaults to sourceFile.pdf/html]

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/resumer. 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 Resumer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.