Update README.md

Author: cyclotruc

README.md

@@ -1,70 +1,75 @@
+[![Image](./docs/frontpage.png "GitIngest main page")](https://gitingest.com/)
+
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
+
 # GitIngest 🔍
+Turn any Git repository into a prompt-friendly text ingest for LLMs.
 
+You can also replace `hub` with `ingest` in any github url to access the coresponding digest
 
-[![Image](./docs/frontpage.png)](https://gitingest.com/)
+[gitingest.com](https://gitingest.com/) 
 
-[gitingest.com](https://gitingest.com/) - Turn any Git repository into a prompt-friendly text ingest for LLMs.
-You can also replace `hub` with `ingest` in any github url to access the coresponding digest
 
 ## 🚀 Features
 
-- **One-Click Analysis**: Simply paste a Git repository URL and get instant pastable context
+- **Easy code context**: Get a text digest from a git repository URL or a directory
 - **Smart Formatting**: Optimized output format for LLM prompts
 - **Statistics about**: :
   - File and directory structure
   - Size of the extract
-  - (soon) Token count  
-- **Web Interface**: Lightweight responsive UI
+  - Token count  
+- **CLI tool**: Run it as a command
+- **Python package**: Import it in your code
 
-## 🛠️ Tech Stack
-- Tailwind CSS
-- FastAPI - Backend framework
-- [apianalytics.dev](https://www.apianalytics.dev/) - Usage tracking
 
-## 📦 Running Tests
+## 📦 Installation
 
-To run the tests, first install the test dependencies:
-```bash
-pip install -r requirements.txt
 ```
-
-Then run the tests with coverage:
-```bash
-cd src
-pytest --cov
+pip install gitingest
 ```
 
-To generate a coverage HTML report:
-```bash
-pytest --cov --cov-report=html
-```
-The report will be available in `htmlcov/index.html`
 
-## 📦 Installation
+## 💡 Command Line usage
 
-1. Clone the repository:
-```bash
-git clone https://github.com/cyclotruc/gitingest.git
-cd gitingest
-```
+The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.
 
-2. Install dependencies:
 ```bash
-pip install -r requirements.txt
+# Basic usage
+gitingest /path/to/directory
+
+# From url
+gitingest https://github.com/cyclotruc/gitingest
+
+# See more options
+gitingest --help
 ```
 
-3. Run the application:
-```bash
-cd src
-uvicorn main:app --reload
+This will write the digest in a text file (default `digest.txt`) in your current working directory.
+
+
+## 🐛 Python package usage
+
+
+```python
+from gitingest import ingest
+
+summary, tree, content = ingest("path/to/directory")
+
+#or from URL
+summary, tree, content = ingest("https://github.com/cyclotruc/gitingest")
 ```
 
+By default, this won't write a file but can be enabled with the `output` argument
 
-The application will be available at `http://localhost:8000`
 
-### Docker
+## 🛠️ Using
+- Tailwind CSS - Frontend
+- [FastAPI](https://github.com/fastapi/fastapi) - Backend framework
+- [tiktoken](https://github.com/openai/tiktoken) - Token estimation
+- [apianalytics.dev](https://www.apianalytics.dev/) - Simple Analytics
 
+
+## 🌐 Self-host 
 1. Build the image:
 ```
 docker build -t gitingest .
@@ -75,82 +80,51 @@ docker build -t gitingest .
 docker run -d --name gitingest -p 8000:8000 gitingest
 ```
 The application will be available at `http://localhost:8000`
+Ensure environment variables are set before running the application or deploying it via Docker.
 
-### 🌐 Environment Configuration
-
-You can configure the application using the following environment variables:
-
-- **`ALLOWED_HOSTS`**: Specify allowed hostnames for the application. Default: `"gitingest.com,*.gitingest.com,gitdigest.dev,localhost"`.
-
-Example:
+## ✔️ Contributing
 
-```bash
-ALLOWED_HOSTS="gitingest.local,localhost"
-```
+Contributions are welcome! 
 
-Ensure these variables are set before running the application or deploying it via Docker.
+Gitingest aims to be friendly for first time contributors, with a simple python and html codebase. If you need any help while working with the code, reach out to us on [discord](https://discord.com/invite/zerRaGK9EC)
 
-## ✔️ Contributions are welcome!
-Create a pull request or open an Issue about anything you'd like to see in gitingest
+### Ways to contribute 
 
-## 🔒 WIP
-- Feedback/suggestions: Please open a github Issue or mail me: romain@coderamp.io
-- Repository cloning is limited to public GitHub repositories only
-- Too big repos will probably timeout (if longer than 20 secondes to clone)
+1. Provide your feedback and ideas on discord
+2. Open an Issue on github to report a bug 
+2. Create a Pull request
+   - Fork the repository
+   - Make your changes and test them locally
+   - Open a pull request for review and feedback
 
+### 🔧 Local dev
 
-## Command Line Global Installation
+####  Environment Configuration
+- **`ALLOWED_HOSTS`**: Specify allowed hostnames for the application. Default: `"gitingest.com,*.gitingest.com,gitdigest.dev,localhost"`.
+You can configure the application using the following environment variables:
 
 ```bash
-pip install -e .
+ALLOWED_HOSTS="gitingest.local,localhost"
 ```
 
-## Command Line Usage
-
-The `gitingest` command line tool allows you to analyze any directory and create a text dump of its contents.
-
-### Basic Usage
-
+#### Run locally
+1. Clone the repository 
 ```bash
-gitingest /path/to/directory
+git clone https://github.com/cyclotruc/gitingest.git
+cd gitingest
 ```
 
-This will create a text file named after your directory (e.g., `directory.txt`) in your current working directory.
-
-### Specifying Output Location
-
+2. Install dependencies
 ```bash
-gitingest /path/to/directory -o /path/to/output.txt
+pip install -r requirements.txt
 ```
 
-### Options
-
-- `-o, --output`: Specify the output file path (default: `<directory_name>.txt` in current directory)
-- `-s, --max-size`: Maximum file size to process in bytes (default: 10MB)
-- `-i, --ignore-pattern`: Additional patterns to ignore (can be used multiple times)
-
-### Examples
-
+3. Run the application:
 ```bash
-# Basic usage
-gitingest ~/projects/myproject
-
-# Custom output location
-gitingest ~/projects/myproject -o ~/Desktop/analysis.txt
-
-# Ignore specific file patterns
-gitingest ~/projects/myproject -i "*.csv" -i "*.json"
-
-# Set maximum file size (e.g., 5MB)
-gitingest ~/projects/myproject -s 5000000
+cd src
+uvicorn main:app --reload
 ```
 
-### Output Format
-
-The generated text file contains:
-1. Summary statistics (file count, directory count, content size)
-2. Directory tree structure
-3. Contents of all text files
+The frontend will be available at `localhost:8000` 
 
-Files and directories that are commonly ignored (like `.git`, `node_modules`, cache directories, etc.) are automatically excluded. You can add additional patterns to ignore using the `-i` flag.