Skip to content

Commit 9283089

Browse files
committed
πŸ“¦πŸ“ Improve package installation instructions
1 parent 88030b3 commit 9283089

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

β€Žproject_name/README.md.jinjaβ€Ž

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,27 @@
2929

3030
## Install
3131

32-
Install the package using pip, or with a dependency manager like uv:
32+
{% if has_cli -%}
33+
Install this tool using pipx (or uv):
34+
{%- else -%}
35+
Install the package using pip (or uv, poetry, etc.):
36+
{%- endif %}
3337

3438
```bash
35-
{%- if in_pypi %}
36-
pip install {{ project_name }}
37-
{%- else %}
38-
pip install git+https://github.com/{{ github_user }}/{{ project_name }}.git`
39+
pip{% if has_cli %}x{% endif %} install
40+
{%- if in_pypi %} {{ project_name }}
41+
{%- else %} git+https://github.com/{{ github_user }}/{{ project_name }}.git
3942
{%- endif %}
4043
```
4144

4245
## Usage
4346

44-
Import the package in your code:
45-
46-
```python
47-
import {{ package_name }}
48-
```
49-
{%- if has_cli %}
50-
51-
or run it directly:
52-
53-
```bash
54-
{{ project_name }} --help
47+
{% if not has_cli -%}
48+
```python-repl
49+
>>> import {{ package_name }}
5550
```
51+
{%- else -%}
52+
Use `{{ project_name }} --help` to learn more.
5653
{%- endif %}
5754

5855
## Development

0 commit comments

Comments
Β (0)