chore: update readme after addition of config feature (#9)

* update readme to include new config feature
* remove references to OPENAI_API_KEY
* fmt & whitespace

Author: craigmayhew

.github/workflows/rust.yml

@@ -2,9 +2,9 @@ name: Rust
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 env:
   CARGO_TERM_COLOR: always
@@ -13,33 +13,33 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Build
-      run: cargo build --verbose
-  
+      - uses: actions/checkout@v4
+      - name: Build
+        run: cargo build --verbose
+
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Run tests
-      env:
-        AI_API_KEY: ${{ secrets.AI_API_KEY }}
-        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-      run: cargo build && cargo test --verbose
+      - uses: actions/checkout@v4
+      - name: Run tests
+        env:
+          AI_API_KEY: ${{ secrets.AI_API_KEY }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        run: cargo build && cargo test --verbose
 
   review:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: GPT Code Review
-      env:
-        AI_API_KEY: ${{ secrets.AI_API_KEY }}
-        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-      run: cargo build && find . -path './target' -prune -o -name '*.rs' -exec echo {} \; -exec cat {} \; | ./target/debug/pipe-gpt --code-review --markdown
+      - uses: actions/checkout@v4
+      - name: GPT Code Review
+        env:
+          AI_API_KEY: ${{ secrets.AI_API_KEY }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        run: cargo build && find . -path './target' -prune -o -name '*.rs' -exec echo {} \; -exec cat {} \; | ./target/debug/pipe-gpt --code-review --markdown
 
   fmt:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Check formatting
-      run: cargo fmt -- --check
+      - uses: actions/checkout@v4
+      - name: Check formatting
+        run: cargo fmt -- --check

README.md

@@ -3,11 +3,27 @@ Pipe your content to gpt directly from the command line. A concept that allows f
 
 Installation via cargo `cargo install pipe-gpt`, build it locally via `cargo build --release`, or download from the releases page.
 
-Please note you will need an [OpenAI API Key](https://platform.openai.com/account/api-keys).
-
-### Set the open api key env var
- - in linux: `export OPENAI_API_KEY=sk-12345abc`
- - in windows powershell `$env:OPENAI_API_KEY = 'sk-12345abc'`
+Please note you will need an api key e.g. [OpenAI API Key](https://platform.openai.com/account/api-keys).
+
+### Set the API key env var
+ - The app reads AI_API_KEY
+ - in linux/macOS: `export AI_API_KEY=sk-12345abc`
+ - in windows powershell `$env:AI_API_KEY = 'sk-12345abc'`
+
+## Configuration
+- Config file path: ~/.config/pipe-gpt/config.yaml (Linux/macOS) or %APPDATA%/pipe-gpt/config.yaml (Windows)
+- Fields and defaults:
+  - api_url: https://api.openai.com/v1/
+  - model: gpt-4o
+  - max_tokens: 8192
+  - temperature: 0.6
+- Example:
+```
+api_url: "https://api.openai.com/v1/"
+model: "gpt-4o"
+max_tokens: 2048
+temperature: 0.6
+```
 
 ## Use cases
 
@@ -16,7 +32,7 @@ Please note you will need an [OpenAI API Key](https://platform.openai.com/accoun
 - `cat main.rs | pipe-gpt -p "How would you improve this code? Include line numbers in your comments so I can tell where you mean."`
 - `cat main.rs | pipe-gpt -p "Is this code production ready? If yes reply 'Yes'. If no, then explain why not. Be concise."`
 - `cat file.json | pipe-gpt -p "Convert this JSON to YAML" > file.yaml`
-- `cat french.txt | pipe-gpt -p "Translate this to English please."` 
+- `cat french.txt | pipe-gpt -p "Translate this to English please."`
 - `git diff --staged | pipe-gpt -p "Code review this code change"`
  - `cat src/main.rs | pipe-gpt -p "improve the code and only output the replacement code as I will pipe the output directly back into a file, no explanations, just pure code please" > src/main.new.rs`
 
@@ -55,7 +71,7 @@ jobs:
       run: cargo test --verbose
     - name: GPT Code Review
       env:
-        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        AI_API_KEY: ${{ secrets.AI_API_KEY }}
       run: pwd && find . -path './target' -prune -o -name '*.rs' -exec echo {} \; -exec cat {} \; | ./target/debug/pipe-gpt -p "how would you improve this code? include line numbers in your comments so I can tell where you mean"
 ```