From 5ad017f59c2efe813de23848dcebebd2bb476603 Mon Sep 17 00:00:00 2001 From: Thaphon Chinnakornsakul <62195081+sunmodza@users.noreply.github.com> Date: Mon, 28 Sep 2026 20:23:50 +0700 Subject: [PATCH] Revise installation and usage instructions in README Updated the README to clarify installation and usage steps for Aiython. --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 016d087..b593d99 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,9 @@ Python program. ## Quick start -Install Aiython with [`uv`](https://docs.astral.sh/uv/): +### 1. Install + +With `uv`: ```bash uv tool install aiython @@ -50,24 +52,32 @@ Or with `pip`: pip install aiython ``` -Set up your AI provider: +### 2. Set up your AI provider ```bash aiython setup ``` -Then run an existing Python script by replacing the command: +### 3. Run your Python script with Aiython -```text -python app.py → aiython app.py +Replace: + +```bash +python app.py ``` -Your script and its arguments stay the same. +with: -Modules work too: +```bash +aiython app.py +``` -```text -python -m package → aiython -m package +Modules work the same way: + +```bash +python -m package +# becomes +aiython -m package ``` ## Example