Skip to content

Commit 59e20ee

Browse files
committed
docs: update README and utility function for consistency
- Corrects the PyPI badge color and CI badge label in the README - Removes redundant installation instructions in the README - Updates the command alias in the README for local development - Adjusts the import path in the utility function to match the package structure
1 parent 1639bbe commit 59e20ee

File tree

3 files changed

+5
-11
lines changed

3 files changed

+5
-11
lines changed

README.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ LLM CLI is a powerful, open-source command-line interface for AI-driven reposito
2121

2222
</div>
2323

24-
[pypi-release-shield]: https://img.shields.io/pypi/v/liblaf-ai-cli?logo=pypi&style=flat&label=PyPI
24+
[pypi-release-shield]: https://img.shields.io/pypi/v/liblaf-ai-cli?color=3775a9&logo=pypi&logoColor=white&style=flat&label=PyPI
2525
[pypi-release-link]: https://pypi.org/project/liblaf-ai-cli/
2626
[github-releasedate-shield]: https://img.shields.io/github/release-date/liblaf/ai-cli?style=flat
2727
[github-releasedate-link]: https://github.com/liblaf/ai-cli/releases
28-
[github-action-ci-shield]: https://img.shields.io/github/actions/workflow/status/liblaf/ai-cli/ci.yaml?label=ci&logo=githubactions&logoColor=white&style=flat
28+
[github-action-ci-shield]: https://img.shields.io/github/actions/workflow/status/liblaf/ai-cli/ci.yaml?label=CI&logo=githubactions&logoColor=white&style=flat
2929
[github-action-ci-link]: https://github.com/liblaf/ai-cli/actions/workflows/ci.yaml
3030
[github-contributors-shield]: https://img.shields.io/github/contributors/liblaf/ai-cli?color=c4f042&style=flat
3131
[github-contributors-link]: https://github.com/liblaf/ai-cli/graphs/contributors
@@ -46,12 +46,6 @@ To install `ai-cli`, run the following command:
4646
uv tool install liblaf-ai-cli
4747
```
4848

49-
or
50-
51-
```bash
52-
pipx install liblaf-ai-cli
53-
```
54-
5549
## ⌨️ Local Development
5650

5751
You can clone it for local development:
@@ -60,7 +54,7 @@ You can clone it for local development:
6054
gh repo clone liblaf/ai-cli
6155
cd ai-cli
6256
uv sync --all-extras
63-
ai-cli --help
57+
ai --help
6458
```
6559

6660
## 🤝 Contributing

src/ai/utils/_get_prompt.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44

55
def get_prompt(name: str) -> str:
6-
prompts_dir: Traversable = importlib.resources.files("ai_cli.assets.prompts")
6+
prompts_dir: Traversable = importlib.resources.files("ai.assets.prompts")
77
fpath: Traversable = prompts_dir / f"{name}.md"
88
return fpath.read_text()

uv.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)