From 33bda930180789ff54ea03bbac7742a3d1c443b8 Mon Sep 17 00:00:00 2001
From: OCram85 <marco.blessing@googlemail.com>
Date: Tue, 14 May 2024 11:13:06 +0200
Subject: [PATCH] fix logo size (#4)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

### 📖 Summary

- fix image display size

### 📑 Test Plan

✅ CI pipeline tests (Default)

### 💬 Details

_No response_

### 📚 Additional Notes

_No response_

Reviewed-on: https://gitea.ocram85.com/plugins/gitea-package/pulls/4
---
 README.md |  5 ++++-
 docs.md   | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 docs.md

diff --git a/README.md b/README.md
index 0e7f968..c32c2bd 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@
   <a href="https://gitea.ocram85.com/plugins/gitea-package/">
     <img
       src="/plugins/gitea-package/raw/branch/main/assets/social-logo.png"
+      width="500"
+      height="500"
       alt="gitea-package"
     >
   </a>
@@ -22,7 +24,8 @@
 
 <p align="center">
   <a href="https://ci.ocram85.com/plugins/gitea-package" target="_blank">
-    <img src="https://ci.ocram85.com/api/badges/plugins/gitea-package/status.svg" alt="Main Branch Build Status">
+    <img src="https://ci.ocram85.com/api/badges/plugins/gitea-package/status.svg"
+    alt="Main Branch Build Status">
   </a>
 </p>
 
diff --git a/docs.md b/docs.md
new file mode 100644
index 0000000..3720bf0
--- /dev/null
+++ b/docs.md
@@ -0,0 +1,64 @@
+---
+name: Gitea Generic Package
+icon: https://raw.githubusercontent.com/go-gitea/gitea/main/assets/logo.svg
+description: Plugin to Publish Artifacts to Gitea Generic Package Registry.
+author: OCram85
+tags: [Gitea, publish-package, container, build]
+containerImage: ocram85/plugin-gitea-package
+containerImageUrl: https://hub.docker.com/r/ocram85/plugin-gitea-package
+url: https://codeberg.org/woodpecker-plugins/docker-buildx
+---
+
+# Overview
+
+Woodpecker CI plugin to upload any file to the _Gitea Generic Package Registry_.
+
+For details about the features and limits of the _Generic Package Registry_ their [docs](https://docs.gitea.com/usage/packages/generic).
+
+## Settings
+
+| Settings Name | Default | Description               |
+| ------------- | ------- | ------------------------- |
+| `user`        | _none_  | Gitea user for basic auth |
+| `password`    | _none_  | Password for basic auth |
+| `debug` | _none_ | Enables debug output if it's set to `true`. |
+| `owner` | _none_ | Package owner |
+| `package_name` | _none_ | The package name |
+| `package_version` | _none_ | Package version |
+| `file_source` | _none_ | File source path for upload. |
+| `file_name` | _none_ | Package file name |
+| `update` | `false` | Allow update existing package files |
+
+## Examples
+
+```yaml
+when:
+  - event: [pull_request, tag, cron]
+  - event: push
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+depends_on:
+  - "ci"
+
+steps:
+  next:
+    image: ocram85/plugin-gitea-package:latest
+    pull: true
+    secrets: [ gitea_user, gitea_passwd]
+    settings:
+      user:
+        from_secret: gitea_user
+      password:
+        from_secret: gitea_passwd
+      debug: "true"
+      owner: "plugins"
+      package_name: "dummy_package"
+      package_version: "0.1.0"
+      file_source: "./README.md"
+      file_name: "readme.md"
+      update: "true"
+    when:
+      event: pull_request
+      branch: ${CI_REPO_DEFAULT_BRANCH}
+```