Skip to content

Commit c955ada

Browse files
authored
Update README.md (#456)
* Update README.md * Update README.md * Update README.md
1 parent 0de5c44 commit c955ada

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<img alt="Patchwork logo" src="https://repository-images.githubusercontent.com/782544882/a9743f35-5e1c-43ed-a0e0-536322056d38" width="36%">
44
</picture>
55
<br>
6-
<img alt="Patchwork GIF" src="patchwork-banner.gif">
6+
<img alt="Patchwork GIF" src="https://raw.githubusercontent.com/patched-codes/patchwork/main/patchwork-banner.gif">
77
</div>
88
<br>
99

@@ -13,7 +13,6 @@
1313
[![Discord](https://dcbadge.limes.pink/api/server/XDxA3mJyhE?style=flat&theme=clean-inverted)](https://discord.gg/XDxA3mJyhE)
1414
[![Downloads](https://img.shields.io/pypi/v/patchwork-cli)](https://pypi.org/project/patchwork-cli/)
1515
[![Downloads](https://static.pepy.tech/badge/patchwork-cli)](https://pepy.tech/project/patchwork-cli)
16-
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL_3.0-blue.svg)](https://github.com/patched-codes/patchwork/blob/main/LICENSE)
1716

1817
[Demo](https://youtu.be/MLyn6B3bFMU) |
1918
[Docs](https://docs.patched.codes/)
@@ -166,10 +165,9 @@ Contributions for new patchflows and steps, or to the core framework are welcome
166165
- To create a new patchflow, follow [these instructions](patchwork/patchflows/README.md).
167166
- To create a new step, follow [these instructions](patchwork/steps/README.md).
168167

169-
We also provide chat assistants to help you create new steps and patchflows easily. Fair warning: they suffer from the same limitations as their underlying model.
168+
We also provide a chat assistant to help you create new steps and patchflows easily.
170169

171-
- [Patchwork Assistant GPT](https://chatgpt.com/g/g-0G4sCAd2y-patchwork-assistant) (based on GPT-4)
172-
- [Patchwork Assistant on HuggingChat ](https://hf.co/chat/assistant/66322701fd4787e0c1f7696b) (based on Llama-3)
170+
- [Patchwork Assistant on HuggingChat](https://hf.co/chat/assistant/66322701fd4787e0c1f7696b) (based on Llama-3)
173171

174172
## Roadmap
175173

patchwork/patchflows/GenerateREADME/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,12 @@ If you do not want the comments in the file to be included set the `suppress_com
6767
suppress_comments: false
6868
```
6969

70+
### README file name
71+
You can change the default README file name from README.md to something you want by using the `markdown_file_name` option.
72+
```yaml
73+
markdown_file_name: Diagram.md
74+
```
75+
7076
### Manage PRs
7177
In addition, there are options to let you manage the PRs as you like, by setting a `branch_prefix`, or disabling the creation of new branches with `disable_branch` (commits will be made on the current branch). You can also disable PR creation with `disable_pr` or force push commits to existing PR with `force_pr_creation`.
7278

0 commit comments

Comments
 (0)