Skip to content

Commit ac31600

Browse files
Add disclaimer to the README about the experimental nature of updating existing projects (#599)
1 parent 51e36e5 commit ac31600

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,15 @@ Automate Python project setup and development tasks that are otherwise performed
2525

2626
Inspired by an [**R** package of the same name](https://usethis.r-lib.org/index.html), this package brings a similar experience to the Python ecosystem as a CLI tool.
2727

28+
> [!TIP]
29+
> `usethis` is great for fresh projects using [uv](https://docs.astral.sh/uv), but also supports updating existing projects. However, this should be considered experimental. If you encounter problems or have feedback, please [open an issue](https://github.com/nathanjmcdougall/usethis-python/issues/new?template=idea.md).
30+
2831
## Highlights
2932

3033
- 🧰 First-class support for state-of-the-practice tooling: `uv`, `ruff`, `pytest`, `pre-commit`, and many more.
3134
- 🤖 Automatically add and remove tools: declare, install, and configure in one step.
3235
- 🧠 Powerful knowledge of how different tools interact and sensible defaults.
36+
- 🔄 Update existing configuration files automatically.
3337
- 📢 Fully declarative project configuration.
3438
- ⚡ Get started on a new Python project or a new workflow in seconds.
3539

0 commit comments

Comments
 (0)