Add: README and LICENSE files

This commit is contained in:
DuckDuckWhale 2020-12-26 23:14:05 -08:00
parent c372291754
commit 9bbde4a332
2 changed files with 44 additions and 0 deletions

19
LICENSE-MIT Normal file
View File

@ -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.

25
README.md Normal file
View File

@ -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).