Skip to content

Commit b9bd099

Browse files
authored
Update INSTALL.md (patched-codes#214)
* Update INSTALL.md update readme to add `--all-extras` for installing via poetry. * Update INSTALL.md * Update README.md
1 parent 55a716d commit b9bd099

File tree

2 files changed

+5
-15
lines changed

2 files changed

+5
-15
lines changed

INSTALL.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,4 @@
1-
# Installation
2-
3-
## Using Pip
4-
5-
PatchWork is available on PyPI and can be installed using pip:
6-
7-
```bash
8-
pip install patchwork-cli --upgrade
9-
```
10-
11-
## Using Poetry
1+
# Build from source
122

133
PatchWork is built using Poetry, a dependency management and packaging tool for Python. To install PatchWork using Poetry, follow these steps:
144

@@ -34,5 +24,5 @@ PatchWork is built using Poetry, a dependency management and packaging tool for
3424

3525
5. Install the dependencies using Poetry:
3626
```
37-
poetry install
38-
```
27+
poetry install --all-extras
28+
```

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ An open-source framework for automating development chores using large language
2929

3030
## Key Components
3131

32-
- **Steps**: Reusable atomic actions like Create PR, commit changes, call an LLM etc
33-
- **Prompt Templates**: Customizable LLM prompts optimized for a chore like library updates, code generation, issue analysis etc.
32+
- **Steps**: Reusable atomic actions like create PR, commit changes or call an LLM.
33+
- **Prompt Templates**: Customizable LLM prompts optimized for a chore like library updates, code generation, issue analysis or vulnerability remediation.
3434
- **Patchflows**: LLM-assisted automations such as PR reviews, code fixing, documentation etc. built by combining steps and prompts.
3535

3636
Patchflows can be run locally in your CLI and IDE, or as part of your CI/CD pipeline. There are [several patchflows available](#patchflows) out of the box, and you can always [create your own](#contributing).

0 commit comments

Comments
 (0)