housekeeping

thatmattlove · Jan 19, 2022 · 174a3c6 · 174a3c6
1 parent 8e01661
commit 174a3c6
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 0 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,22 @@
+name: test
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+
+      - name: Go Setup
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
+
+      - name: Run Tests
+        run: go test -v ./...
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Version Updates
+
+To update the version, run `./version.sh <version>`. This will update the `.version` file (which is imported to the codebase at build time), commit the change, and add a git tag. This should be the last step before pushing changes.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,32 @@
+The Clear BSD License
+
+Copyright (c) 2022 Matthew Love
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
+
+     * Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+     * Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+     * Neither the name of the copyright holder nor the names of its
+     contributors may be used to endorse or promote products derived from this
+     software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+<div align="center">
+<h3>
+    <code>oui</code>
+</h3>
+<br/>
+MAC Address CLI Toolkit
+<br/>
+<br/>
+    <a href="https://github.com/thatmattlove/oui/actions?query=workflow%3Atest">
+        <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/thatmattlove/oui/test?style=for-the-badge">
+    </a>
+</div>
+
+## Installation
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Version Updates

		To update the version, run `./version.sh <version>`. This will update the `.version` file (which is imported to the codebase at build time), commit the change, and add a git tag. This should be the last step before pushing changes.