From ad79c7f2527e6e48b5ecc0a66e6de260fa3ac17b Mon Sep 17 00:00:00 2001 From: Nick White Date: Sat, 14 Nov 2020 15:20:27 +0000 Subject: Add basic README --- README | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..43d8465 --- /dev/null +++ b/README @@ -0,0 +1,29 @@ +# njw.name/bbcschedule package + +This package is a command that lists the schedule for a BBC radio +station. + +This is a Go package, and can be installed in the standard go way, +by running `git clone https://git.njw.name/bbcschedule` and +`go install .` from the bbcschedule directory. + +## Usage + + Usage: bbcschedule [-station stationname] [-date yyyy-mm-dd] [-v] + + Lists the schedule for a BBC radio station for a day. + -date string + Date of schedule + -station string + Radio station name (called 'service id' by BBC) (default "bbc_radio_fourfm") + -v Verbose - use long descriptions for programmes + +## Contributions + +Any and all comments, bug reports, patches or pull requests would +be very welcomely received. Please email them to . + +## License + +This package is licensed under the GPLv3. See the LICENSE file for +more details. -- cgit v1.2.3