Skip to content

Commit

Permalink
README.md: various small fixes (cyclotruc#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
waldyrious authored Jan 4, 2025
1 parent 19be25a commit 1f8a41a
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
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

0 comments on commit 1f8a41a

Please sign in to comment.