Skip to content

Commit

Permalink
Add custom exception base class, improve code organization.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Jan 8, 2024
1 parent 5020ae1 commit 18410d9
Show file tree
Hide file tree
Showing 18 changed files with 448 additions and 578 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,9 @@ See the <a href="#-configuration">Configuration</a> section below for the comple
</details>
<!-- -->
<details closed>
<summary>🧩 Templates</summary>
<br>This feature is currently under development. The template system will allow users to generate README files in different flavors, such as ai, data, web development, etc.
<br>
<summary>🧩 Template READMEs</summary>
<p>This feature is currently under development. The template system will allow users to generate README files in different flavors, such as ai, data, web development, etc.
</p>
<table>
<tr>
<td>
Expand Down
93 changes: 21 additions & 72 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,21 @@
<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-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>
---
title: Lorem ipsum dolor sit amet
---

# 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 |
Loading

0 comments on commit 18410d9

Please sign in to comment.