From 0dbd23b0478b81cde9e951f7b0d36eb37e5c1380 Mon Sep 17 00:00:00 2001
From: pips <pips@e5150.fr>
Date: Thu, 31 Jul 2025 00:36:12 +0200
Subject: [PATCH] chore(readme): add simple readme file

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7ce38f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# golang-vendor-private
+
+CI plugin to retrieve private go modules in local vendor folder.
+
+Tested with woodpecker-ci >= 3
+
+## Sample
+
+```yaml
+steps:
+  - name: vendor
+    image: forge.e5150.fr/ci-plugins/golang-vendor-private:latest
+    settings:
+      goprivate: forge.e5150.fr
+      login:
+        from_secret: test-username
+      password:
+        from_secret: test-token
+```
+
+## Settings
+
+| Settings name | Type | Description |
+| --------------- | --------------- | --------------- |
+| `goprivate` | string | pattern for private go modules |
+| `login` | string | login to access repository |
+| `password` | string | password to access repository |