Skip to content

Commit

Permalink
docs: update README and utility function for consistency
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
liblaf committed Nov 30, 2024
1 parent 1639bbe commit 59e20ee
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 11 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ LLM CLI is a powerful, open-source command-line interface for AI-driven reposito

</div>

[pypi-release-shield]: https://img.shields.io/pypi/v/liblaf-ai-cli?logo=pypi&style=flat&label=PyPI
[pypi-release-shield]: https://img.shields.io/pypi/v/liblaf-ai-cli?color=3775a9&logo=pypi&logoColor=white&style=flat&label=PyPI
[pypi-release-link]: https://pypi.org/project/liblaf-ai-cli/
[github-releasedate-shield]: https://img.shields.io/github/release-date/liblaf/ai-cli?style=flat
[github-releasedate-link]: https://github.com/liblaf/ai-cli/releases
[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
[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
[github-action-ci-link]: https://github.com/liblaf/ai-cli/actions/workflows/ci.yaml
[github-contributors-shield]: https://img.shields.io/github/contributors/liblaf/ai-cli?color=c4f042&style=flat
[github-contributors-link]: https://github.com/liblaf/ai-cli/graphs/contributors
Expand All @@ -46,12 +46,6 @@ To install `ai-cli`, run the following command:
uv tool install liblaf-ai-cli
```

or

```bash
pipx install liblaf-ai-cli
```

## ⌨️ Local Development

You can clone it for local development:
Expand All @@ -60,7 +54,7 @@ You can clone it for local development:
gh repo clone liblaf/ai-cli
cd ai-cli
uv sync --all-extras
ai-cli --help
ai --help
```

## 🤝 Contributing
Expand Down
2 changes: 1 addition & 1 deletion src/ai/utils/_get_prompt.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@


def get_prompt(name: str) -> str:
prompts_dir: Traversable = importlib.resources.files("ai_cli.assets.prompts")
prompts_dir: Traversable = importlib.resources.files("ai.assets.prompts")
fpath: Traversable = prompts_dir / f"{name}.md"
return fpath.read_text()
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 59e20ee

Please sign in to comment.