Skip to content

Commit 2dccfa0

Browse files
authored
README.md: various small fixes
1 parent 19be25a commit 2dccfa0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
Turn any Git repository into a prompt-friendly text ingest for LLMs.
1515

16-
You can also replace `hub` with `ingest` in any github url to access the coresponding digest
16+
You can also replace `hub` with `ingest` in any GitHub URL to access the coresponding digest
1717

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

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

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

37-
## 💡 Command Line usage
37+
## 💡 Command line usage
3838

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

4141
```bash
4242
# Basic usage
4343
gitingest /path/to/directory
4444

45-
# From url
45+
# From URL
4646
gitingest https://github.com/cyclotruc/gitingest
4747

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

103103
### Ways to help (non-technical)
104104

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

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

120120
### Run web UI locally
121121

122-
1. Clone the repository
122+
1. Clone the repository:
123123

124124
```bash
125125
git clone https://github.com/cyclotruc/gitingest.git
126126
cd gitingest
127127
```
128128

129-
2. Install dependencies
129+
2. Install dependencies:
130130

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

145-
4. Run unit tests
145+
4. Run unit tests:
146146

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

153153
### Working on the CLI
154154

155-
1. Install the package in dev mode
155+
1. Install the package in dev mode:
156156

157157
```bash
158158
pip install -e .
159159
```
160160

161-
2. Run the CLI
161+
2. Run the CLI:
162162

163163
```bash
164164
gitingest --help

0 commit comments

Comments
 (0)