From 8263c039d5922e9b40b3570c6248faa03672f71d Mon Sep 17 00:00:00 2001
From: robin <comfysagedev@gmail.com>
Date: Thu, 19 Feb 2026 18:40:10 +0100
Subject: [PATCH] doc: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bbc72c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# ebil - ebil.club cli
+
+## usage
+
+push your site files to ebil.club:
+
+```bash
+ebil push --site robin.ebil.club dist/
+```
+
+pull your site from ebil.club to a local directory:
+
+```bash
+ebil pull --site robin.ebil.club site/
+```
+
+## installation
+
+simply install using make:
+
+```bash
+sudo make install
+```
+
+or install for user:
+
+```bash
+PREFIX="$HOME/.local" make install
+```
+
+or run using :sparkles: _nix_ :sparkles: :
+
+```bash
+nix run git+https://codeberg.org/comfysage/ebil.git --
+```
+
+## env
+
+you can set certain options using environment variables.
+
+| env                           | option                   |
+| ----------------------------- | ------------------------ |
+| `EBIL_SITE="robin.ebil.club"` | `--site robin.ebil.club` |
+| `EBIL_PATH="dist/"`           | `--path dist/`           |
+
+## note
+
+specify options _before_ regular arguments.
-- 
2.51.2