Skip to content

Commit

Permalink
Update example images for the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Jan 6, 2024
1 parent 49e0b0b commit 96c3023
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 86 deletions.
116 changes: 30 additions & 86 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ See a few examples headers generated by *readme-ai* below.
</table>

See the <a href="#-configuration">Configuration</a> section below for the complete list of CLI options and settings.<br>
<!-- -->

<details closed>
<summary>📑 Codebase Documentation</summary>
<br>
Expand Down Expand Up @@ -215,7 +215,7 @@ See the <a href="#-configuration">Configuration</a> section below for the comple
</details>
<!-- -->
<details closed>
<summary>🤝 Contributing Guidelines, License, & More</summary>
<summary>🤝 Contributing Guidelines & More</summary>
<br>
<table>
<tr>
Expand All @@ -224,7 +224,15 @@ See the <a href="#-configuration">Configuration</a> section below for the comple
</td>
</tr>
<tr>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/contributing.png" alt="contributing-guidelines" width="700" /></td>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/additional-sections.png" alt="contributing-and-more" width="700" /></td>
</tr>
<tr>
<td style="padding-top:20px;"><b>Contributing Guidelines</b><br>
<p>The contributing guidelines has a dropdown that outlines a general process for contributing to your project.</p>
</td>
</tr>
<tr>
<td align="center"><img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/images/contributing-guidelines.png" alt="contributing-guidelines" width="700" /></td>
</tr>
</table>
</details>
Expand Down Expand Up @@ -257,89 +265,25 @@ See the <a href="#-configuration">Configuration</a> section below for the comple
</tr>
</table>
</details>
<!-- -->
<details closed>
<summary>🎨 Examples</summary>
<br>
<table>
<thead>
<tr>
<th></th>
<th>Output File</th>
<th>Repository</th>
<th>Languages</th>
</tr>
</thead>
<tbody>
<tr>
<td>1️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-python.md">readme-python.md</a></td>
<td><a href="https://github.com/eli64s/readme-ai">readme-ai</a></td>
<td>Python</td>
</tr>
<tr>
<td>2️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/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>
</tr>
<tr>
<td>3️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-postgres.md">readme-postgres.md</a></td>
<td><a href="https://github.com/jwills/buenavista">postgres-proxy-server</a></td>
<td>Python, Postgres, Duckdb, Docker</td>
</tr>
<tr>
<td>4️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/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>
</tr>
<tr>
<td>5️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-streamlit.md">readme-streamlit.md</a></td>
<td><a href="https://github.com/eli64s/readme-ai-streamlit">readme-ai-streamlit</a></td>
<td>Python, Streamlit</td>
</tr>
<tr>
<td>5️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/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>
</tr>
<tr>
<td>6️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/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>
</tr>
<tr>
<td>7️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/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>
</tr>
<tr>
<td>8️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/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>
</tr>
<tr>
<td>9️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/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>
</tr>
<tr>
<td>🔟</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-pyflink.md">readme-pyflink.md</a></td>
<td><a href="https://github.com/eli64s/flink-flow">flink-flow</a></td>
<td>PyFlink</td>
</tr>
</tbody>
</table>
</details>

### Example README Files

Below are a few [example](https://github.com/eli64s/readme-ai/blob/main/examples/markdown) README files generated by readme-ai.

| | **Output File 📄** | **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 |
|| [readme-typescript.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-typescript.md) | [chatgpt-app-react-ts](https://github.com/Yuberley/ChatGPT-App-React-Native-TypeScript) | TypeScript, React |
|| [readme-postgres.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-postgres.md) | [postgres-proxy-server](https://github.com/jwills/buenavista) | Postgres, Duckdb |
|| [readme-kotlin.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-kotlin.md) | [file.io-android-client](https://github.com/rumaan/file.io-Android-Client) | Kotlin, Android |
|| [readme-streamlit.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-streamlit.md) | [readme-ai-streamlit](https://github.com/eli64s/readme-ai-streamlit) | Python, Streamlit |
|| [readme-rust-c.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-rust-c.md) | [rust-c-app](https://github.com/DownWithUp/CallMon) | C, Rust |
|| [readme-go.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-go.md) | [go-docker-app](https://github.com/olliefr/docker-gs-ping) | Go |
|| [readme-java.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-java.md) | [java-minimal-todo](https://github.com/avjinder/Minimal-Todo) | Java |
|| [readme-fastapi-redis.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-fastapi-redis.md) | [async-ml-inference](https://github.com/FerrariDG/async-ml-inference) | FastAPI, Redis |
|| [readme-mlops.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-mlops.md) | [mlops-course](https://github.com/GokuMohandas/mlops-course) | Python, Jupyter |
|| [readme-pyflink.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-pyflink.md) | [flink-flow](https://github.com/eli64s/flink-flow) | PyFlink |


---

Expand Down
Binary file added examples/images/additional-sections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/images/code-directory-tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/images/code-summary-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/images/contributing-guidelines.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed examples/images/contributing.png
Binary file not shown.
Binary file modified examples/images/features-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/images/getting-started.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file modified examples/images/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 96c3023

Please sign in to comment.