Skip to content

Commit

Permalink
Update project documentation and examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
@eli64s
eli64s committed Jan 29, 2024
1 parent 06f17ba commit 5d34fb6
Showing 1 changed file with 82 additions and 24 deletions.
106 changes: 82 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,6 @@ See the <a href="#-configuration">Configuration</a> section below for the comple

# Example READMEs

Explore [example README.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown) files generated by readme-ai below.

| ⭑ | **Output File 📄** | **Input Repository 📁** | **Repository Type 🔢** |
|---|-------------|------------|-----------|
| ⭑ | [readme-python.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-python.md) | [readme-ai](https://github.com/eli64s/readme-ai) | Python |
Expand Down Expand Up @@ -414,10 +412,16 @@ readmeai -r https://github.com/eli64s/readme-ai

Using `streamlit`

Try readme-ai directly in your browser with <a href="https://streamlit.io/">Streamlit</a>, no installation required! See <a href="https://github.com/eli64s/readme-ai-streamlit">readme-ai-streamlit</a> for more details.
Try it directly in your browser on <a href="https://streamlit.io/">Streamlit</a>, no installation required!

[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://readme-ai.streamlit.app/)

<sub>
Source code for readme-ai's Streamlit app can be found <a href="https://github.com/eli64s/readme-ai-streamlit">here</a>.
</sub>

<br>

<details closed>
<summary>From <code>source</code></summary>
<br>
Expand Down Expand Up @@ -462,34 +466,37 @@ nox -f noxfile.py

Run the `readmeai` command in your terminal with the following options to tailor your README file.

#### Command-Line Options
----

#### CLI Options

| Option | Description | Values | Default Value | Data Type |
| --------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -------------- | -------------- |
| `-a`, `--align` | Align the text in the README.md file's header. | `center`, `left` | `center` | String |
| `--align`, `-a` | Align the text in the README.md file's header. | `center`, `left` | `center` | String |
| `--api-key` | LLM API key to generate text for the README.md file. | | | String |
| `-b`, `--badges` | Badge icon style types for README.md badges. | `default`, `flat`, `flat-square`, `for-the-badge`, `plastic`, `skills`, `skills-light`, `social` | `default` | String |
| `-e`, `--emojis` | Adds emojis to the README.md file's header sections. | | `False` | Boolean |
| `-i`, `--image` | Project logo image displayed in the README file header. | `CUSTOM`, `DEFAULT`, `BLACK`, `GRADIENT`, `GREY`, `PURPLE`, `YELLOW`, `CLOUD` | `DEFAULT` | String |
| 🚧 `--language` | Language for generating the README.md file. | | `en` | String |
| `--badges`, `-b` | Badge icon style types for README.md badges. | `flat`, `flat-square`, `for-the-badge`, `plastic`, `skills`, `skills-light`, `social` | `default` | String |
| `--emojis`, `-e` | Adds emojis to the README.md file's header sections. | | `False` | Boolean |
| `--image`, `-i` | Project logo image displayed in the README file header. | `CUSTOM`, `BLACK`, `GRADIENT`, `GREY`, `PURPLE`, `YELLOW`, `CLOUD` | `DEFAULT` | String |
| `🚧 --language` | Language for generating the README.md file. | | `en` | String |
| `--max-tokens` | Maximum number of tokens for each section of the README.md file. | | | Integer |
| `-m`, `--model` | GPT language model for generating various sections of the README.md file. | | | String |
| `--model`, `-m` | GPT language model for generating various sections of the README.md file. | | | String |
| `--offline` | Generates a README.md file without API calls, with placeholders for generated content. | | `False` | Boolean |
| `-o`, `--output` | Output file name for the README file. | | `readme-ai.md` | String |
| `-r`, `--repository` | Remote repository URL or local directory path for the project. | | | String |
| `-t`, `--temperature` | Sets the creativity level for content generation. | `0.0` to `2.0` | `1.0` | Float |
| 🚧 `--template` | README template file for generating the README.md file. | | | String |
| `--output`, `-o` | Output file name for the README file. | | `readme-ai.md` | String |
| `--repository`, `-r` | Remote repository URL or local directory path for the project. | | | String |
| `--temperature`, `-t` | Sets the creativity level for content generation. | `0.0 to 2.0` | `1.0` | Float |
| `🚧 --template` | README template file for generating the README.md file. | | | String |
| `--vertex_ai` | Google Vertex AI configuration, requires location and project ID. | | | Tuple (String) |
| `--help` | Displays help information about the command and its options. | | | |

<sub><em><code>🚧 feature currently under development</code></em>

<sub><em>🚧</em> = feature currently under development.<br>For additional command-line information, run <code>readmeai --help</code> in your terminal for more details about each option.</sub><br>
---

**Badge Icons**
#### Badges

Select your preferred badge icon style to display in your output file using the `--badges` flag. The default badge style displays basic metadata about your repository using shields.io badges. If you select another option, the `default` badges will be automatically included.
The `--badges` option lets you select the style of icons used in the README file header.

| **Options** | **Preview** |
| **Style** | **Preview** |
|------------------|----------|
| `default` | ![license](https://img.shields.io/github/license/eli64s/readme-ai?flat&color=0080ff) ![last-commit](https://img.shields.io/github/last-commit/eli64s/readme-ai?flat&color=0080ff) ![languages](https://img.shields.io/github/languages/top/eli64s/readme-ai?flat&color=0080ff) ![language-count](https://img.shields.io/github/languages/count/eli64s/readme-ai?flat&color=0080ff) |
| `flat` | ![flat](https://img.shields.io/badge/Python-3776AB.svg?&style=flat&logo=Python&logoColor=white) |
Expand All @@ -500,11 +507,61 @@ Select your preferred badge icon style to display in your output file using the
| `skills-light` | [![Skills-Light](https://skillicons.dev/icons?i=py&theme=light)](https://skillicons.dev) |
| `social` | ![social](https://img.shields.io/badge/Python-3776AB.svg?&style=social&logo=Python&logoColor=white) |


When providing the `--badges` option, readme-ai does two things:

1. Formats the default badge set to match the selection (i.e. flat, flat-square, etc.).
2. Generates an additional badge set representing your projects dependencies and tech stack (i.e. Python, Docker, etc.)

<br>

**Project Logo**
`Example:`


```sh
readmeai --repository https://github.com/eli64s/readme-ai --badges flat-square
```

`Output:`

> {... project logo ...}
>
> {... project name ...}
>
> {...project slogan...}
>
> <img src="https://img.shields.io/github/license/eli64s/readme-ai?style=flat&color=0080ff">
> <img src="https://img.shields.io/github/last-commit/eli64s/readme-ai?style=flat&logo=git&?logoColor=white&color=0080ff">
> <img src="https://img.shields.io/github/languages/top/eli64s/readme-ai?style=flat&color=0080ff">
> <img src="https://img.shields.io/github/languages/count/eli64s/readme-ai?style=flat&color=0080ff">
>
> <br>
>
> *Developed with the software and tools below.*
>
> <img src="https://img.shields.io/badge/GNU%20Bash-4EAA25.svg?style=flat&logo=GNU-Bash&logoColor=white">
> <img src="https://img.shields.io/badge/tqdm-FFC107.svg?style=flat&logo=tqdm&logoColor=black">
> <img src="https://img.shields.io/badge/Pydantic-E92063.svg?style=flat&logo=Pydantic&logoColor=white">
> <img src="https://img.shields.io/badge/YAML-CB171E.svg?style=flat&logo=YAML&logoColor=white" alt="YAML">
> <img src="https://img.shields.io/badge/Poetry-60A5FA.svg?style=flat&logo=Poetry&logoColor=white">
> <img src="https://img.shields.io/badge/OpenAI-412991.svg?style=flat&logo=OpenAI&logoColor=white">
> <br>
> <img src="https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white">
> <img src="https://img.shields.io/badge/AIOHTTP-2C5BB4.svg?style=flat&logo=AIOHTTP&logoColor=white">
> <img src="https://img.shields.io/badge/Docker-2496ED.svg?style=flat&logo=Docker&logoColor=white">
> <img src="https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat&logo=GitHub-Actions&logoColor=white">
> <img src="https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white">
>
> <br>
>
> {... end of header ...}
>

---

#### Project Logo

Select an image to display in your README header section using the `--image` flag.
Select a project logo using the `--image` option to display in the README file header.

| **Options** | **Preview** |
|---------------|----------------|
Expand All @@ -516,12 +573,13 @@ Select an image to display in your README header section using the `--image` fla
| **yellow** | <img src="https://img.icons8.com/pulsar-color/96/markdown.png" width="100"> |
| **cloud** | <img src="https://cdn-icons-png.flaticon.com/512/6295/6295417.png" width="100"> |

To provide your own image, use the CLI option `--image custom` and you will be prompted to enter a URL to your image.
<br>
To provide your own image, use `--image custom` which will prompt you for the image URL.

---

#### Pydantic Models and Settings
#### Pydantic Models

For more details about the configuration settings, see the [project documentation](https://eli64s.github.io/readme-ai/) or jump right into the [settings file](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml).
For more details about the CLI settings and configuration, see the [documentation](https://eli64s.github.io/readme-ai/) or jump right into the [code!](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml)

<p align="right">
<a href="#top"><b>Return</b></a>
Expand Down

0 comments on commit 5d34fb6

Please sign in to comment.