owenvoke/rugby-schedule

Rugby schedules on the command-line

v1.12.1 2024-10-10 09:26 UTC

README

Latest Version on Packagist Software License Static Analysis Total Downloads Buy us a tree

Rugby Schedule is a command-line tool that keeps you up to date with rugby tournament schedules.

Install

Requires PHP 8.2 or later

Via Composer

composer global require owenvoke/rugby-schedule

Via Docker

docker run --rm ghcr.io/owenvoke/rugby-schedule:latest

Usage

Tournaments

The following tournament commands are available:

Men's Rugby

Women's Rugby

Under-18s Rugby

Under-20s Rugby

See the output of rugby-schedule for all available commands and their usage, or use --help to display extended usage information for a specific command.

Viewing Matches for a Specific Team

The --team (or -t) flag can be used to filter to a specific team (e.g. --team england).

This flag is available on all commands, however it may not be supported on all competitions.

Viewing Calendar Links

You can view available calendar links (e.g. Google Calendar, Outlook Calendar) that allow you to add an event to your calendar.

To do this, include the --include-calendar-links (or -c) flag when calling a command.

Viewing Past Matches

By default, past matches are excluded from the output. These can be included if necessary by using the --include-past (or -p) flag when calling a command.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.