Skip to content

README.md: various small fixes #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cyclotruc merged 1 commit into from
Jan 4, 2025
Merged

README.md: various small fixes #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

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
You can also replace `hub` with `ingest` in any GitHub URL to access the coresponding digest

[gitingest.com](https://gitingest.com)

Expand All @@ -25,7 +25,7 @@ You can also replace `hub` with `ingest` in any github url to access the corespo
- File and directory structure
- Size of the extract
- Token count
- **CLI tool**: Run it as a command (Currently on Linux only)
- **CLI tool**: Run it as a shell command (currently on Linux only)
- **Python package**: Import it in your code

## 📦 Installation
Expand All @@ -34,15 +34,15 @@ You can also replace `hub` with `ingest` in any github url to access the corespo
pip install gitingest
```

## 💡 Command Line usage
## 💡 Command line usage

The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.

```bash
# Basic usage
gitingest /path/to/directory

# From url
# From URL
gitingest https://github.com/cyclotruc/gitingest

# See more options
Expand Down Expand Up @@ -102,8 +102,8 @@ Gitingest aims to be friendly for first time contributors, with a simple python

### Ways to help (non-technical)

- Provide your feedback and ideas on discord
- Open an Issue on github to report a bug / submit an feature request
- Provide your feedback and ideas on Discord
- Open an issue on GitHub to report a bug / submit a feature request
- Talk about Gitingest on social media

### How to submit a PR
Expand All @@ -119,14 +119,14 @@ Gitingest aims to be friendly for first time contributors, with a simple python

### Run web UI locally

1. Clone the repository
1. Clone the repository:

```bash
git clone https://github.com/cyclotruc/gitingest.git
cd gitingest
```

2. Install dependencies
2. Install dependencies:

```bash
pip install -r requirements-dev.txt
Expand All @@ -142,7 +142,7 @@ Gitingest aims to be friendly for first time contributors, with a simple python
uvicorn main:app --reload
```

4. Run unit tests
4. Run unit tests:

```bash
pytest
Expand All @@ -152,13 +152,13 @@ The application should be available at `http://localhost:8000`

### Working on the CLI

1. Install the package in dev mode
1. Install the package in dev mode:

```bash
pip install -e .
```

2. Run the CLI
2. Run the CLI:

```bash
gitingest --help
Expand Down
Loading