Skip to content

Commit

Permalink
‣ Light restructure of readme contents.
Browse files Browse the repository at this point in the history
  • Loading branch information
@eli64s
eli64s committed Jul 31, 2023
1 parent 9caa208 commit 31c9d46
Showing 1 changed file with 103 additions and 102 deletions.
205 changes: 103 additions & 102 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
<img src="https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style&logo=GitHub-Actions&logoColor=white" alt="actions" />
</p>
<a href="https://pypi.org/project/readmeai/">
<img src="https://img.shields.io/pypi/v/readmeai?labelColor=lightgrey&color=grey" alt="pypi-version" />
<img src="https://img.shields.io/pypi/v/readmeai?color=5D6D7E&logo=pypi" alt="pypi-version" />
</a>
<a href="https://pypi.org/project/readmeai/">
<img src="https://img.shields.io/pypi/pyversions/readmeai?labelColor=lightgrey&color=grey" alt="python-versions" />
<img src="https://img.shields.io/pypi/pyversions/readmeai?color=5D6D7E&logo=python" alt="pypi-python-version" />
</a>
<a href="https://pepy.tech/project/readmeai">
<img src="https://static.pepy.tech/personalized-badge/readmeai?period=total&units=none&left_color=lightgrey&right_color=grey&left_text=downloads" alt="downloads" />
<a href="https://pypi.org/project/readmeai/">
<img src="https://img.shields.io/pypi/dm/readmeai?color=5D6D7E" alt="pypi-downloads" />
</a>
<img src="https://img.shields.io/github/license/eli64s/readme-ai?labelColor=lightgrey&color=grey" alt="github-license" />
<img src="https://img.shields.io/github/license/eli64s/readme-ai?color=5D6D7E" alt="github-license" />
</div>

---
Expand Down Expand Up @@ -177,91 +177,88 @@ Additionally, frequently monitor your API usage and costs by visiting the [OpenA
| ![contribute](https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/closing.png) |

<h1 align="center">⒎<br>👇<br><br>💥 Example Files</h1>
<p align="center">Markdown example files generated by the README-AI app!</p>
<div align="center">
<table align="center">
<tr>
<th></th>
<th>Example File</th>
<th>Repository</th>
<th>Language</th>
<th>Bytes</th>
</tr>
<tr>
<td>1️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-python.md">readme-python.md</a></td>
<td><a href="https://github.com/eli64s/readme-ai">readme-ai</a></td>
<td>Python</td>
<td>
<p>19,839</p>
</td>
</tr>
<tr>
<td>2️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-typescript.md">readme-typescript.md</a></td>
<td><a href="https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript">chatgpt-app-react-typescript</a></td>
<td>TypeScript, React</td>
<td><p>988</p></td>
</tr>
<tr>
<td>3️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-javascript.md">readme-javascript.md</a></td>
<td><a href="https://github.com/idosal/assistant-chat-gpt">assistant-chat-gpt-javascript</a></td>
<td>JavaScript, React</td>
<td><p>212</p></td>
</tr>
<tr>
<td>4️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md">readme-kotlin.md</a></td>
<td><a href="https://github.com/rumaan/file.io-Android-Client">file.io-android-client</a></td>
<td>Kotlin, Java, Android</td>
<td><p>113,649</p></td>
</tr>
<tr>
<td>5️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-rust-c.md">readme-rust-c.md</a></td>
<td><a href="https://github.com/DownWithUp/CallMon">rust-c-app</a></td>
<td>C, Rust</td>
<td><p>72</p></td>
</tr>
<tr>
<td>6️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-go.md">readme-go.md</a></td>
<td><a href="https://github.com/olliefr/docker-gs-ping">go-docker-app</a></td>
<td>Go</td>
<td><p>41</p></td>
</tr>
<tr>
<td>7️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-java.md">readme-java.md</a></td>
<td><a href="https://github.com/avjinder/Minimal-Todo">java-minimal-todo</a></td>
<td>Java</td>
<td><p>17,725</p></td>
</tr>
<tr>
<td>8️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md">readme-fastapi-redis.md</a></td>
<td><a href="https://github.com/FerrariDG/async-ml-inference">async-ml-inference</a></td>
<td>Python, FastAPI, Redis</td>
<td><p>355</p></td>
</tr>
<tr>
<td>9️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-mlops.md">readme-mlops.md</a></td>
<td><a href="https://github.com/GokuMohandas/mlops-course">mlops-course</a></td>
<td>Python, Jupyter</td>
<td><p>8,524</p></td>
</tr>
<tr>
<td>🔟</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-pyflink.md">readme-pyflink.md</a></td>
<td><a href="https://github.com/eli64s/flink-flow">flink-flow</a></td>
<td>PyFlink</td>
<td><p>32</p></td>
</tr>
</table>
</div>

<p align="center">Markdown example files generated by the *readme-ai* app!</p>
<table align="center">
<tr>
<th></th>
<th>Example File</th>
<th>Repository</th>
<th>Language</th>
<th>Bytes</th>
</tr>
<tr>
<td>1️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-python.md">readme-python.md</a></td>
<td><a href="https://github.com/eli64s/readme-ai">readme-ai</a></td>
<td>Python</td>
<td>
<p>19,839</p>
</td>
</tr>
<tr>
<td>2️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-typescript.md">readme-typescript.md</a></td>
<td><a href="https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript">chatgpt-app-react-typescript</a></td>
<td>TypeScript, React</td>
<td><p>988</p></td>
</tr>
<tr>
<td>3️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-javascript.md">readme-javascript.md</a></td>
<td><a href="https://github.com/idosal/assistant-chat-gpt">assistant-chat-gpt-javascript</a></td>
<td>JavaScript, React</td>
<td><p>212</p></td>
</tr>
<tr>
<td>4️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md">readme-kotlin.md</a></td>
<td><a href="https://github.com/rumaan/file.io-Android-Client">file.io-android-client</a></td>
<td>Kotlin, Java, Android</td>
<td><p>113,649</p></td>
</tr>
<tr>
<td>5️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-rust-c.md">readme-rust-c.md</a></td>
<td><a href="https://github.com/DownWithUp/CallMon">rust-c-app</a></td>
<td>C, Rust</td>
<td><p>72</p></td>
</tr>
<tr>
<td>6️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-go.md">readme-go.md</a></td>
<td><a href="https://github.com/olliefr/docker-gs-ping">go-docker-app</a></td>
<td>Go</td>
<td><p>41</p></td>
</tr>
<tr>
<td>7️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-java.md">readme-java.md</a></td>
<td><a href="https://github.com/avjinder/Minimal-Todo">java-minimal-todo</a></td>
<td>Java</td>
<td><p>17,725</p></td>
</tr>
<tr>
<td>8️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md">readme-fastapi-redis.md</a></td>
<td><a href="https://github.com/FerrariDG/async-ml-inference">async-ml-inference</a></td>
<td>Python, FastAPI, Redis</td>
<td><p>355</p></td>
</tr>
<tr>
<td>9️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-mlops.md">readme-mlops.md</a></td>
<td><a href="https://github.com/GokuMohandas/mlops-course">mlops-course</a></td>
<td>Python, Jupyter</td>
<td><p>8,524</p></td>
</tr>
<tr>
<td>🔟</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/readme-pyflink.md">readme-pyflink.md</a></td>
<td><a href="https://github.com/eli64s/flink-flow">flink-flow</a></td>
<td>PyFlink</td>
<td><p>32</p></td>
</tr>
</table>

<h1 align="center">⒏<br>👇<br><br>📜 Custom README templates coming soon!</h1>
<p align="center">Developing a feature that allows users to select from a variety of README formats and styles.</p>
Expand All @@ -279,9 +276,9 @@ Additionally, frequently monitor your API usage and costs by visiting the [OpenA

Before you begin, ensure that you have the following prerequisites installed:

- Python 3.9 or higher
- Conda or Poetry package manager (recommended)
- Access to the OpenAI API (see the setup guide below)
- Python 3.9, 3.10, 3.11
- Pip, Poetry, Conda, or Docker (see installation methods below)
- OpenAI API account and api key (see setup instructions below)

#### 📂 Repository

Expand Down Expand Up @@ -321,28 +318,32 @@ To use the *README-AI* app, you must create an OpenAI API account and generate a

### 📦 Installation

1. Clone the *readme-ai* repository to your machine.
Use any of the following methods to install project dependencies.

> *Pip ([PyPI Package](https://pypi.org/project/readmeai/))*
```sh
git clone https://github.com/eli64s/readme-ai
pip install readmeai
```

2. Navigate to the *readme-ai* directory.
> *Docker ([Docker Hub](https://hub.docker.com/repository/docker/zeroxeli/readme-ai/general))*
```sh
cd readme-ai
docker pull zeroxeli/readme-ai:latest
```

3. Use any of the following methods to install project dependencies.
If you prefer to install the project dependencies locally, follow the steps below.

> *Pip ([PyPI Package](https://pypi.org/project/readmeai/))*
1. Clone the *readme-ai* repository to your machine.
```sh
pip install readmeai
git clone https://github.com/eli64s/readme-ai
```

> *Docker ([Docker Hub](https://hub.docker.com/repository/docker/zeroxeli/readme-ai/general))*
2. Navigate to the *readme-ai* directory.
```sh
docker pull zeroxeli/readme-ai:latest
cd readme-ai
```

3. Install the project dependencies using one of the following methods.

> *Bash*
```sh
bash setup/setup.sh
Expand Down

0 comments on commit 31c9d46

Please sign in to comment.