From 653a2c6992e1a8da93303eca85f8d2925d278a73 Mon Sep 17 00:00:00 2001 From: Eli <43382407+eli64s@users.noreply.github.com> Date: Tue, 26 Sep 2023 11:10:44 -0500 Subject: [PATCH] Fix html table formatting. --- README.md | 338 +++++++++++++++++++++++++--------------------- docs/README-fr.md | 2 +- pyproject.toml | 2 +- 3 files changed, 187 insertions(+), 155 deletions(-) diff --git a/README.md b/README.md index 5e095ad7..62ef54ed 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -
+
-[![fr](https://img.shields.io/badge/fr-🇫🇷-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-fr.md) -[![zh-CN](https://img.shields.io/badge/zh--CN-🇨🇳-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/README-zh-CN.md) +[![zh-CN](https://img.shields.io/badge/zh--CN-🇨🇳-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-zh-CN.md) +[![fr](https://img.shields.io/badge/FR-🇫🇷-white?style=plastic)](https://github.com/eli64s/readme-ai/blob/main/docs/README-fr.md)
@@ -89,9 +89,11 @@ This project is currently under development and has an opinionated configuration ## 🤖 Features +
+
- -

❶ Project Badges

+ + ❶ Project Badges @@ -99,11 +101,10 @@ This project is currently under development and has an opinionated configuration

Project Slogan and Badges

‣ A slogan to highlight your poject is generated by prompting OpenAI's GPT engine. -

+

‣ Codebase dependencies and metadata are visualized using Shields.io badges.

- @@ -113,177 +114,208 @@ This project is currently under development and has an opinionated configuration
-
- -

Codebase Documentation

- - - -

Directory Tree and File Summaries

-

- ‣ Your project's directory structure is visualized using a custom tree function. -

-

- ‣ Each file in the codebase is summarized by OpenAI's GPT model. -

- - - - - -
- repository-tree - - code-summaries -
-
-
- -

❸ Overview and Features Table

- - - - - - - - -
-

Prompted Text Generation

-

- ‣ An overview paragraph and features table are generated using detailed prompts, embedded with project metadata. -

-
- feature-table -
-
-
- -

❹ Dynamic Usage Instructions

- - - - - - - - -
-

Installation, Running, and Test

-

- ‣ Generates instructions for installing, running, and testing your project. Instructions are created by identifying the codebase's top language and referring to our language_setup.toml configuration file. -

-
- usage-instructions -
-
-
- -

❺ Contributing Guidelines and more!

- - - - - -
- - - -
- roadmap -
- license -
-
-
- -

❻ Custom Templates - coming soon!

- -

‣ Developing CLI option letting users select from a variety of README styles

-

‣ Templates for use-cases such as data, machine learning, web development, and more!

-
-
- -

❼ Example README Files

- - - - - - - - - - - + +
+
+
+ + ❷ Codebase Documentation + +
Output FileRepositoryLanguages
- - - - + - - - - + - - - - + + +
1️⃣readme-python.mdreadme-aiPython +

Directory Tree and File Summaries

+
2️⃣readme-typescript.mdchatgpt-app-react-typescriptTypeScript, React +

‣ Your project's directory structure is visualized using a custom tree function.

+

‣ Each file in the codebase is summarized by OpenAI's GPT model.

+
3️⃣readme-javascript.mdassistant-chat-gpt-javascriptJavaScript, React + repository-tree + + code-summaries +
+
+
+
+
+
+ + ❸ Overview and Features Table + + - - - - + - - - - + +
4️⃣readme-kotlin.mdfile.io-android-clientKotlin, Java, Android +

Prompted Text Generation

+

+ ‣ An overview paragraph and features table are generated using detailed prompts, embedded with project metadata. +

+
5️⃣readme-rust-c.mdrust-c-appC, Rust + feature-table +
+
+
+
+
+
+ + ❹ Dynamic Usage Instructions
+ + - - - - + - - - - + +
6️⃣readme-go.mdgo-docker-appGo +

Installation, Running, and Test

+

+ ‣ Generates instructions for installing, running, and testing your project. Instructions are created by identifying the codebase's top language and referring to our language_setup.toml configuration file. +

+
7️⃣readme-java.mdjava-minimal-todoJava + usage-instructions +
+
+
+
+
+
+ + ❺ Contributing Guidelines and more!
+ + - - - - + +
- - - - + +
8️⃣readme-fastapi-redis.mdasync-ml-inferencePython, FastAPI, Redis + roadmap +
9️⃣readme-mlops.mdmlops-coursePython, Jupyter + license +
+
+
+
+
+
+ + ❻ Custom Templates - coming soon
+ + - - - - + - -
🔟readme-pyflink.mdflink-flowPyFlink +
    +
  • Developing CLI option letting users select from a variety of README styles
    • +
  • Templates for use-cases such as data, machine learning, web development, and more!
    • +
+
-
+ + +
+
+
+
+ + ❼ Example README Files
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Output FileRepositoryLanguages
1️⃣readme-python.mdreadme-aiPython
2️⃣readme-typescript.mdchatgpt-app-react-typescriptTypeScript, React
3️⃣readme-javascript.mdassistant-chat-gpt-javascriptJavaScript, React
4️⃣readme-kotlin.mdfile.io-android-clientKotlin, Java, Android
5️⃣readme-rust-c.mdrust-c-appC, Rust
6️⃣readme-go.mdgo-docker-appGo
7️⃣readme-java.mdjava-minimal-todoJava
8️⃣readme-fastapi-redis.mdasync-ml-inferencePython, FastAPI, Redis
9️⃣readme-mlops.mdmlops-coursePython, Jupyter
🔟readme-pyflink.mdflink-flowPyFlink
+
+
+

🔝 Return

+ --- ## 👩‍💻 Usage diff --git a/docs/README-fr.md b/docs/README-fr.md index f65ef279..b8f97b3b 100644 --- a/docs/README-fr.md +++ b/docs/README-fr.md @@ -107,7 +107,7 @@ Ce projet est actuellement en développement et a une configuration opinâtre. B
-

Documentation du Code Source

+

❷ Documentation du Code Source

 diff --git a/pyproject.toml b/pyproject.toml index f7976b13..596914e3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "readmeai" -version = "0.3.086" +version = "0.3.093" description = "🚀 Generate beautiful README.md files from the terminal. Powered by OpenAI's GPT LLMs 💫" authors = ["Eli <0x.eli.64s@gmail.com>"] license = "MIT"