Skip to content

Commit

Permalink
Update project documenation.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Mar 1, 2024
1 parent a2b0840 commit 9fbd3bc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
7 changes: 3 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ All notable changes to the readme-ai project will be documented in this file.

---

## [v0.5.64] - *2024-03-01*
## [v0.5.65] - *2024-03-01*

This release introduces new LLM integrations (`Google Vertex AI` and `Ollama`), enhances the CLI, and improves the project's documentation. Additionally, this release is bumped to version `0.5.64` to align with the PyPI package version.

## 🚀 Features

### CLI Options

- feat: Add CLI options to enhance README.md file customization.
- **`--alignment`**: Rename option to control the alignment of the README header text from *--align* to *--alignment*.
- **`--api`**: Select LLM API service to use for generating README content - *offline*, *ollama*, *openai*, *vertex*.
Expand All @@ -36,10 +37,8 @@ This release introduces new LLM integrations (`Google Vertex AI` and `Ollama`),

### LLM Integrations

- feat: Integrate Ollama for local model support. @eli64s (#92)
- feat: Integrate Google Vertex AI LLM @eli64s (#90)
- Export `VERTEXAI_LOCATION` and `VERTEXAI_PROJECT` to environment.
- Add CLI flag `--api VERTEX` to use the Google Vertex AI LLM.


## 🧹 Chore

Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,8 +307,8 @@ See the <a href="#-configuration">Configuration</a> section below for the comple
**Choosing an LLM Service:**

- [**OpenAI**](https://platform.openai.com/docs/quickstart/account-setup): Recommended, requires an API key and account setup.
- [**Google Vertex AI**](https://cloud.google.com/vertex-ai/docs/quickstart): Requires Google Cloud project and service account
- [**Ollama**](https://github.com/ollama/ollama): Free and open-source, potentially slower and more resource-intensive.
- [**Google Vertex AI**](https://cloud.google.com/vertex-ai/docs): Requires Google Cloud project and service account
- [**Offline Mode**](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-offline.md): Free, generates a boilerplate README without making API calls.


Expand Down Expand Up @@ -362,8 +362,7 @@ An OpenAI API account and API key are needed to use readme-ai. Get started by cr
> ```
<details closed>
<summary><h4>From <code>source</code></h4>
</summary>
<summary>From <code>source</code></summary>
> Clone repository and change directory.
>
Expand Down Expand Up @@ -460,8 +459,7 @@ Using `Ollama`
> <sub>Try directly in your browser on <a href="https://streamlit.io/">Streamlit</a>, no installation required! For more details, check out the <a href="https://github.com/eli64s/readme-ai-streamlit">readme-ai-streamlit</a> repository.</sub>
<details closed>
<summary><h4>From <code>source</code></h4>
</summary>
<summary>From <code>source</code></summary>
#### Using `bash`
>
Expand Down

0 comments on commit 9fbd3bc

Please sign in to comment.