From ca7bb72088d2ec17a2ae78cb5d8259cb2eb225f8 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Thu, 6 Mar 2025 13:37:00 +0100
Subject: Initial cli and entrypoints

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 7524838..f717262 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,44 @@
 # Strangeloop
 
 A recursive and self-referential AI agent framework.
+
+## Installation
+
+Run the latest version directly without installation from `uvx`:
+
+```bash
+$ uvx strangeloop
+```
+
+For developers, from within working copy run:
+
+```bash
+$ uv run strangeloop
+```
+
+## CLI Usage
+
+Strangeloop provides a command-line interface with several commands:
+
+```bash
+# Display help
+strangeloop --help
+
+# Print a hello message
+strangeloop hello
+
+# Greet a user
+strangeloop greet [NAME]
+
+# Display information about the environment
+strangeloop info
+strangeloop info --verbose
+
+# Process a file
+strangeloop process FILE_PATH [--output OUTPUT_PATH]
+```
+
+You can also run the CLI directly without installation:
+
+```bash
+python main.py --help
-- 
cgit v1.3.1