Merge pull request #6 from shanehull/chore/add-docs-and-license

Chore/add docs and license

.github/workflows/lint.yaml

@@ -0,0 +1,24 @@
+name: Lint
+
+on:
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  Lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: "1.21"
+          cache: false
+      - name: Lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.55

.github/workflows/test.yaml

@@ -0,0 +1,22 @@
+name: Test
+
+on:
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  Test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: "1.21"
+          cache: false
+      - name: Test
+        run: go test ./...

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Shane A. Hull
+
+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.

README.md

@@ -0,0 +1,16 @@
+# shed
+
+A dev toolbox for The Shed.
+
+This is a monolith cli tool written in Go, containing everything I think I need to enhance my productivity.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Go Report](https://goreportcard.com/badge/github.com/shanehull/shed)](https://goreportcard.com/report/github.com/shanehull/shed)
+
+[![Test Workflow](https://github.com/shanehull/shed/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/shanehull/shed/actions/workflows/test.yaml/badge.svg?branch=main)
+[![Lint Workflow](https://github.com/shanehull/shed/actions/workflows/lint.yaml/badge.svg?branch=main)](https://github.com/shanehull/shed/actions/workflows/lint.yaml/badge.svg?branch=main)
+[![Release Workflow](https://github.com/shanehull/shed/actions/workflows/release.yaml/badge.svg?branch=release)](https://github.com/shanehull/shed/actions/workflows/release.yaml/badge.svg?branch=release)
+
+The tool itself is probably no use to you, but due to the way [`urfave/cli`](https://github.com/urfave/cli) defines commands, you can just copy/paste any command you like and use it in your own project.
+
+They are all located [here](https://github.com/shanehull/shed/tree/main/cmd/shed) (e.g. `shed_awesomecmd.go`) and imported [here](https://github.com/shanehull/shed/blob/main/cmd/shed/main.go).