From bc89086419b1b73fefe1320f2b9979e436c09853 Mon Sep 17 00:00:00 2001
From: Sheogorath <sheogorath@shivering-isles.com>
Date: Sat, 28 Oct 2023 15:50:48 +0200
Subject: [PATCH] docs(cowsay): Add README

---
 images/cowsay/README.md | 140 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 140 insertions(+)
 create mode 100644 images/cowsay/README.md

diff --git a/images/cowsay/README.md b/images/cowsay/README.md
new file mode 100644
index 000000000..8f1c400c3
--- /dev/null
+++ b/images/cowsay/README.md
@@ -0,0 +1,140 @@
+cowsay
+===
+
+<!---
+This is the cowsay image. It a distroless based image for cowsay, allowing to use cowsay in any OCI compatible container environment with as little overhead as possible.
+
+You feel like you need cow to tell you something? No problem, just `podman run --rm -it quay.io/shivering-isles/cowsay "Something"`. We'll provide you with a cow telling you something, as quick as possible!
+--->
+
+```
+ _________________________________________ 
+/ This is the cowsay image. It a          \
+| distroless based image for cowsay,      |
+| allowing to use cowsay in any OCI       |
+| compatible container environment with   |
+| as little overhead as possible.         |
+|                                         |
+| You feel like you need cow to tell you  |
+| something? No problem, just `podman run |
+| --rm -it quay.io/shivering-isles/cowsay |
+| "Something"`. We'll provide you with a  |
+| cow telling you something, as quick as  |
+\ possible!                               /
+ ----------------------------------------- 
+        \   ^__^
+         \  (oo)\_______
+            (__)\       )\/\
+                ||----w |
+                ||     ||
+
+
+```
+
+Building
+---
+
+<!---
+This cowsay container uses earthly to build. Therefore in order to build, please checkout https://earthly.dev. Once you have earthly installed, you can just run `earthly git.shivering-isles.com/shivering-isles/infrastructure-gitops/images/cowsay+container`.
+
+I agree, it's quite a mouth full, but just keep chewing on it! You can make your own cows this way!
+
+Oh, and if you already cloned the repository, it's just `earthly ./images/cowsay+container`.
+--->
+
+```
+ _________________________________________ 
+/ This cowsay container uses earthly to   \
+| build. Therefore in order to build,     |
+| please checkout https://earthly.dev.    |
+| Once you have earthly installed, you    |
+| can just run `earthly                   |
+| git.shivering-isles.com/shivering-isles |
+| /infrastructure-gitops/images/cowsay+co |
+| ntainer`.                               |
+|                                         |
+| I agree, it's quite a mouth full, but   |
+| just keep chewing on it! You can make   |
+| your own cows this way!                 |
+|                                         |
+| Oh, and if you already cloned the       |
+| repository, it's just `earthly          |
+\ ./images/cowsay+container`.             /
+ ----------------------------------------- 
+        \   ^__^
+         \  (oo)\_______
+            (__)\       )\/\
+                ||----w |
+                ||     ||
+
+```
+
+References
+---
+
+<!--- 
+This image is based on cowsay from the cowsay organisation. Means it's officially in perl.
+
+You can find them at: https://github.com/cowsay-org/cowsay/
+
+They are a nice herd, so be friendly.
+
+Also a shoutout to Scott Williams who started this mayhem with distroless cows!
+
+https://mastodon.online/@vwbusguy/111309874085945955
+--->
+
+```
+ _________________________________________ 
+/ This image is based on cowsay from the  \
+| cowsay organisation. Means it's         |
+| officially in perl.                     |
+|                                         |
+| You can find them at:                   |
+| https://github.com/cowsay-org/cowsay/   |
+|                                         |
+| They are a nice herd, so be friendly.   |
+|                                         |
+| Also a shoutout to Scott Williams who   |
+| started this mayhem with distroless     |
+| cows!                                   |
+|                                         |
+| https://mastodon.online/@vwbusguy/11130 |
+\ 9874085945955                           /
+ ----------------------------------------- 
+        \   ^__^
+         \  (oo)\_______
+            (__)\       )\/\
+                ||----w |
+                ||     ||
+
+```
+
+License
+---
+
+<!---
+The content of this directory is licensed under the same license as the official cowsay project. At the time of writing this is GPL-3.0 license.
+
+The current reference to the upstream license is: https://github.com/cowsay-org/cowsay/blob/v3.7.0/LICENSE.txt
+--->
+
+```
+ _________________________________________ 
+/ The content of this directory is        \
+| licensed under the same license as the  |
+| official cowsay project. At the time of |
+| writing this is GPL-3.0 license.        |
+|                                         |
+| The current reference to the upstream   |
+| license is:                             |
+| https://github.com/cowsay-org/cowsay/bl |
+\ ob/v3.7.0/LICENSE.txt                   /
+ ----------------------------------------- 
+        \   ^__^
+         \  (oo)\_______
+            (__)\       )\/\
+                ||----w |
+                ||     ||
+
+```
-- 
GitLab