Skip to content

Commit 31610a2

Browse files
authored
🎨 Update README.md
1 parent e77ee0b commit 31610a2

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ AI-powered python code documentation and test generation tool
88
[![write-the - test](https://badgen.net/badge/write-the/tests/green?icon=https://raw.githubusercontent.com/Wytamma/write-the/master/images/write-the-icon.svg)](https://github.com/Wytamma/write-the/actions/workflows/tests.yml)
99
[![codecov](https://codecov.io/gh/Wytamma/write-the/branch/master/graph/badge.svg?token=yEDn56L76k)](https://app.codecov.io/gh/Wytamma/write-the/tree/master)
1010

11-
Write-the is an AI-powered documentation and test generation tool that leverages GPTs to automatically write tests, generate documentation, and refactor code. It is designed to streamline the development process, improve code quality, and increase productivity.
11+
Write-the is an AI-powered documentation and test generation tool that leverages Generative Pre-trained Transformers (GPTs) / Large Language Models (LLMs) to automatically write tests, generate documentation, and refactor code. It is designed to streamline the development process, improve code quality, and increase productivity.
1212

1313
![](https://raw.githubusercontent.com/Wytamma/write-the/master/images/write-the-docs.gif)
1414

@@ -25,6 +25,13 @@ Write-the is an AI-powered documentation and test generation tool that leverages
2525
```console
2626
pip install write-the
2727
```
28+
29+
`write-the` should ideally be installed in an isolated enviroment with a tool like [`pipx`](https://github.com/pypa/pipx).
30+
31+
```console
32+
pipx install write-the
33+
```
34+
2835
## Features
2936

3037
Write-the offers the following AI-driven features:

0 commit comments

Comments
 (0)