Skip to content

Commit

Permalink
Clean up text in readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Jan 1, 2024
1 parent b5ef17a commit fa52812
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,20 +76,20 @@ You can also run the readme-ai without an API key, passing the `--offline` flag

README-AI is built with flexibility in mind, allowing users to customize various aspects of the README file using CLI options and configuration settings. Currently, 4 pieces of information used in the output file are generated using GPT language model APIs.

- **Project slogan displayed in the README header.**
- **Codebase file summaries display in markdown tables.**
- **Overview section that highlights your project's value proposition.**
- **Features section that overviews technical components of your codebase**
- Project slogan phrase that is displayed in the header.
- Codebase file summaries displayed in markdown tables.
- Overview section that highlights the project's value proposition.
- Features table that provides technical details about the codebase.

The rest of the content is extracted using from analyzing repository metadata, configuration settings, and templates.
All other content is extracted from processing and analyzing repository metadata, configuration settings, and templates.

### Customizable Header

The header section is built using repository metadata and including the following information.
- **Badges**: Svg icons are built using codebase metadata. Current options are provided by [shields.io](https://shields.io/) and [skill-icons](https://github.com/tandpfun/skill-icons)!
- **Project Logo**: Select from a handful of default images or provide your own to the CLI.
- **Project Slogan**: A catch phrase is created by prompting OpenAI's LLM API.
- **Table of Contents/Quick Links**: Help users navigate the README file.
The header section is built using repository metadata and includes the following details.
- **Badges**: Svg icons representing project metadata, provided by [shields.io](https://shields.io/) and [skill-icons](https://github.com/tandpfun/skill-icons).
- **Project Logo**: Select a project logo from the default set, or provide your own link.
- **Project Slogan**: Catch phrase describing your project generated using OpenAI's API.
- **Table of Contents/Quick Links**: Links to the different sections of the README file.

Examples of different header configurations generated by readme-ai are shown below.

Expand All @@ -107,7 +107,8 @@ Examples of different header configurations generated by readme-ai are shown bel
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/header-gradient.png" alt="gradient" width="400"/><br><code>--badges flat-square --image gradient</code></td>
</tr>
</table>

For more information about the header section, see the [Configuration](#-configuration) section below.
<br><br>
<details closed><summary>📑 Codebase Documentation</summary>
<br>
<table>
Expand Down

0 comments on commit fa52812

Please sign in to comment.