Prepy

.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+    - name: Install uv
+      run: curl -LsSf https://astral.sh/uv/install.sh | sh
+    - name: Create virtual environment
+      run: uv venv
+    - name: Activate virtual environment
+      run: source .venv/bin/activate
+    - name: Install dependencies
+      run: uv pip install -e ".[dev]"
+    - name: Run tests
+      run: uv run pytest . 

.gitignore

@@ -1,3 +1,7 @@
 *pyc
 # **/*txt
-__pycache__
+__pycache__
+.grkrc
+*txt
+*.log
+*.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 wr1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-[![Tests](https://github.com/wr1/cfold/actions/workflows/python-app.yml/badge.svg)](https://github.com/wr1/cfold/actions/workflows/python-app.yml)
+#![Tests](https://github.com/wr1/cfold/actions/workflows/python-app.yml/badge.svg)](https://github.com/wr1/cfold/actions/workflows/python-app.yml)
 ![Version](https://img.shields.io/github/v/release/wr1/cfold)
 
 # cfold
@@ -11,11 +11,10 @@
 pip install .
 ```
 
-Or install locally with Poetry:
+Or install locally with UV:
 
 ```bash
-poetry install
-python -m pip install .
+uv pip install .
 ```
 
 ## Usage
@@ -40,6 +39,12 @@ Example (fold only code files):
 cfold fold -o folded.txt --dialect codeonly
 ```
 
+Or simply
+```bash
+cfold fold
+```
+![alt text](docs/assets/image.png)
+
 ### Unfolding a codebase
 
 Unfold a modified fold file back into a directory structure: