From 9bbde4a3323f48372829ca421776d7af1b065a60 Mon Sep 17 00:00:00 2001 From: DuckDuckWhale Date: Sat, 26 Dec 2020 23:14:05 -0800 Subject: [PATCH] Add: README and LICENSE files --- LICENSE-MIT | 19 +++++++++++++++++++ README.md | 25 +++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 LICENSE-MIT create mode 100644 README.md diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..5635588 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright 2020 Yuchen Jing + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..168fbc7 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Gitea Timings + +A command line tool that fetches time tracking data from the Gitea API and +pretty-prints a tabular summary. + +## Example + +``` +You spent 7 hours and 59 minutes on 9 issues in the last 24 hours: ++----------+---------------------------------------------------------------+ +| 02:30:02 | Example big feature | +| 02:13:17 | Gitea Timings | +| 00:38:07 | A normal issue except this one has a relatively long name | +| 00:33:58 | ____ _ _ _____ _ _ | +| 00:30:28 | / ___(_) |_ ___ __ _ |_ _(_)_ __ ___ (_)_ __ __ _ ___ | +| 00:30:08 | | | _| | __/ _ \/ _` | | | | | '_ ` _ \| | '_ \ / _` / __| | +| 00:23:22 | | |_| | | || __/ (_| | | | | | | | | | | | | | | (_| \__ \ | +| 00:21:04 | \____|_|\__\___|\__,_| |_| |_|_| |_| |_|_|_| |_|\__, |___/ | +| 00:18:40 | |___/ | ++----------+---------------------------------------------------------------+ +``` + +## License + +This project is licensed under the [MIT license](LICENSE-MIT).