Add README.md

README.md

@@ -0,0 +1,27 @@
+# Pinata is Yet Another Pinterest Frontend.
+
+<img src="https://codeberg.org/gigirassy/pinata/raw/branch/main/screenies/pinata.png" alt="pinata-screenshot">
+
+Self-explanatory. It's built with the idea of being light as possible, and shamefully vibecoded.
+
+The Docker image, built by you, ranges between 5-7 MB, and the entire workings depend on a single main.go.
+
+Pinata takes very little memory to run, about 8MB of memory with an Alpine docker image.
+
+## How to run
+
+### Go
+
+Port 8080 is needed to run with this method; Docker is most recommended if that is taken.
+
+* Clone this repo.
+* ``go build -trimpath -ldflags="-s -w" -o pinata ./main.go``
+* Wait a few seconds for that tasty binary.
+* Run in background with ``./pinata &``
+
+### Docker Compose (recommended)
+
+* Clone this repo.
+* Tweak ``compose.yml`` as you see fit.
+* ``sudo docker compose up -d`` to build and run.
+* Need to update? ``git pull && docker compose up -d --build``