Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharparam/purtea
Ruby tool to manage Purgatorium's TEA stats
https://github.com/sharparam/purtea
ff14 fflogs ffxiv hacktoberfest ruby
Last synced: 5 days ago
JSON representation
Ruby tool to manage Purgatorium's TEA stats
- Host: GitHub
- URL: https://github.com/sharparam/purtea
- Owner: Sharparam
- License: mpl-2.0
- Created: 2021-04-24T11:45:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T12:58:16.000Z (over 1 year ago)
- Last Synced: 2024-11-07T08:51:30.195Z (8 days ago)
- Topics: ff14, fflogs, ffxiv, hacktoberfest, ruby
- Language: Ruby
- Homepage:
- Size: 267 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Purtea
[![Gem][gem-version-badge]][gem]
[![GitHub Workflow Status (master)][workflow-main-master-badge]][workflow-main-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:
```ruby
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](https://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][coc].
Any additional contribution guidelines are outlined in the file [CONTRIBUTING.md][contrib].
## License
Copyright © 2021 by [Adam Hellberg][sharparam].
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][coc].
[gem]: https://rubygems.org/gems/purtea
[gem-version-badge]: https://img.shields.io/gem/v/purtea
[workflow-main]: https://github.com/Sharparam/purtea/actions/workflows/main.yml
[workflow-main-badge]: https://github.com/Sharparam/purtea/actions/workflows/main.yml/badge.svg
[workflow-main-master]: https://github.com/Sharparam/purtea/actions/workflows/main.yml?query=branch%3Amaster
[workflow-main-master-badge]: https://github.com/Sharparam/purtea/actions/workflows/main.yml/badge.svg?branch=master
[coc]: https://github.com/Sharparam/purtea/blob/master/CODE_OF_CONDUCT.md
[contrib]: https://github.com/Sharparam/purtea/blob/master/CONTRIBUTING.md
[sharparam]: https://github.com/Sharparam
[purgatorium]: https://www.fflogs.com/guild/id/79779
[ffxiv]: https://eu.finalfantasyxiv.com/