Added license and readme

This commit is contained in:
Leon Mika 2025-01-04 14:33:44 +11:00
parent 3403deb463
commit 3defe55599
2 changed files with 34 additions and 0 deletions

7
LICENSE.txt Normal file
View file

@ -0,0 +1,7 @@
Copyright (c) 2025 Leon Mika
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.

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# send2gokapi
Small CLI tool to upload files to a [Gokapi](https://github.com/Forceu/Gokapi) instance.
## Usage
In order to use this tool, the following environment variables must be set:
- `SEND2GOKAPI_URL`: Base URL of a Gokapi instance. For example: `https://your.gokapi.url/`.
- `SEND2GOKAPI_API_KEY`: API Key
```shell
send2gokapi [OPTIONS] FILES
```
Valid options:
- `-d`: Max number of downloads allowed for each uploaded file (0 = unlimited). Default is 5
- `-t`: Number of days to keep files (0 = unlimited). Default is 7.
## Installation
If you have Go:
```shell
$ go install lmika.dev/cmd/send2gokapi@latest
```