Skip to content

Commit 839d519

Browse files
author
Your Name
committed
Merge branch 'docs/update-readme'
2 parents e129d8a + 4b4c690 commit 839d519

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# git-scribe
22

33
<p align="center">
4-
<img src="https://raw.githubusercontent.com/popyson1648/git-llm/main/logo.png" alt="git-scribe logo" width="200"/>
4+
<img src="https://raw.githubusercontent.com/popyson1648/git-scribe/main/logo.png" alt="git-scribe logo" width="200"/>
55
</p>
66

77
<p align="center">
@@ -34,7 +34,7 @@
3434

3535
## Demo
3636

37-
![Demo of git-scribe in action](assets/demo.gif)
37+
![Demo of git-scribe in action](https://raw.githubusercontent.com/popyson1648/git-scribe/main/assets/demo.gif)
3838

3939
## Features
4040

@@ -54,13 +54,17 @@
5454

5555
### 1. Install `git-scribe`
5656

57-
You can install the tool directly from this GitHub repository:
57+
You can install the tool from PyPI:
5858

5959
```bash
60-
pip install git+https://github.com/popyson1648/git-llm.git
60+
pip install popyson-git-scribe
6161
```
6262

63-
*(Note: Once published to PyPI, this will become `pip install git-scribe`)*
63+
Alternatively, you can install it directly from the GitHub repository for the latest development version:
64+
65+
```bash
66+
pip install git+https://github.com/popyson1648/git-scribe.git
67+
```
6468

6569
### 2. Initial Setup
6670

@@ -159,11 +163,15 @@ Contributions are welcome! Please feel free to open an issue or submit a pull re
159163

160164
1. Clone the repository.
161165
2. Create a virtual environment and activate it.
162-
3. Install the package in editable mode with development dependencies:
166+
3. Install pre-commit hooks:
167+
```bash
168+
pre-commit install
169+
```
170+
4. Install the package in editable mode with development dependencies:
163171
```bash
164172
pip install -e .[dev]
165173
```
166-
4. Run tests:
174+
5. Run tests:
167175
```bash
168176
pytest
169177
```

0 commit comments

Comments
 (0)