From c18acda3eba27478e71356c62a46ff7177f1c5cc Mon Sep 17 00:00:00 2001 From: "Wyatt J. Miller" Date: Fri, 20 Nov 2020 02:54:34 -0500 Subject: [PATCH] added documentation --- CONTRIBUTING | 1 + README.md | 36 +++++++++++++++++++++++++++++++++++- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..1eb8ce9 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1 @@ +hey is this on? \ No newline at end of file diff --git a/README.md b/README.md index 16382da..af29e83 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # gt -A gitea command-line client \ No newline at end of file +A gitea command-line client + +[![Build Status](https://cicd.wyattjmiller.com/api/badges/wyatt/gt/status.svg?ref=refs/heads/master)](https://cicd.wyattjmiller.com/wyatt/gt) + +## What's this? + +TODO: Fill this out with stuff and things + +## Installation + +TODO: Fill this out, too, with installation instructions + +## Compliation + +TODO: Fill this out on how to compile this + +## Use + +TODO: Fill this out with user friendly-ness! + +### Command-line options + +TODO: Fill this out with various command-line options + +## Contributing + +If you or your company enjoy this Gitea client, consider helping me out in developing this project! Send me a pull request, file an issue, or send a donation. Please see the [CONTRIBUTING](CONTRIBUTING) file for more details. + +## Troubleshooting + +TODO: Fill this out with troubleshooting steps + +## Known issues + +TODO: Fill this out with known issues the program may have \ No newline at end of file