Purtea

Gem GitHub Workflow Status (master)

A tool to manage integrations for the Purgatorium static in FFXIV.

The features provided may be useful to other statics as well.

Installation

Add this line to your application's Gemfile:

gem 'purtea'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install mygem

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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 rubygems.org.

Contributing

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

Any additional contribution guidelines are outlined in the file CONTRIBUTING.md.

License

Copyright © 2021 by Adam Hellberg.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Code of Conduct

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