Add README.md

1 files changed, 47 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..064e7e4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# `upload-artifact`
+
+As its name suggests, this project defines a simple shell script that
+allows to upload one or more artifacts to a
+[`slcl`](https://gitea.privatedns.org/xavi/slcl) instance.
+
+In the context of Forgejo and Gitea, this shell script and `slcl` can
+be used as minimalistic alternatives to
+[`actions/checkout@v4`](https://code.forgejo.org/actions/checkout),
+since this action requires a Node.JS Docker image to run, as well as
+some non-trivial complexity on the action itself.
+
+## How to use
+
+Set up the following environment variables:
+
+- `URL`: URL to the `slcl` instance.
+- `USERNAME`: username to log into.
+- `PASSWORD`: password for the given username.
+
+Then, call `upload-artifact` with the list of artifacts to upload:
+
+```
+upload-artifact <artifact> ...
+```
+
+## License
+
+```
+upload-artifact, upload tool for slcl instances
+Copyright (C) 2025  Xavier Del Campo Romero
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+```
+
+Also, see [`LICENSE`](LICENSE).