diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9e87107 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2025 William Harbert + +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. \ No newline at end of file diff --git a/README.md b/README.md index 51ce09e..19c7ef6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -# Go Application Template +# Go Library Template ## Structure - ``` my-lib/ ├── lib1/ # Individual importable library. Duplicate as needed @@ -13,17 +12,38 @@ my-lib/ └── pgk1_test.go ``` - ## Use -- `git clone https://git.develent.net/wiharb/go-template-lib.git [project-name]` +- `git clone git.develent.net/wiharb/go-template-app.git [project-name]` - `cd ./[project-name]` - `rm -rf ./.git` -- Rename and duplicate `lib1` and `internal/pkg1` as needed +- Rename and duplicate `cmd/app1` and `internal/pkg1` as needed - `go mod init [package_name]` -- Update `./.vscode/launch.json::"program"` to the correct path(s); probably a lib test +- Update `./.vscode/launch.json::"program"` to the correct binary path(s) - Reinitialize git - `git init` - `git add .` - `git commit -m "init"` - `git remote add origin http://[user]:[token]@git.develenet.net/wiharb/[repo].git` - `git push -u origin master` + +--- DELETE AFTER INITIALIZATION ^ + +# Project Name + +## Overview +[One or two sentences explaining what the project does and why it exists] + +## Features +[Bullet points of what it can do] + +## Installation +[How to install the app or add the module] + +## Usage +[CLI examples for apps, code snippets for libs] + +## (Optional)Configuration +[ Describe `.env`, config files, or CLI flags] + +## (Optional)Contributing +[How to build, test, and contribute] \ No newline at end of file