Skip to content

Commit e1e1f35

Browse files
committed
🖊 Update project documentation and example files.
1 parent 85c43a0 commit e1e1f35

13 files changed

+743
-683
lines changed

‎CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ All notable changes to the *readme-ai* project will be documented in this file.
2828
- Update configuration [ignore_files.toml](https://github.com/eli64s/readme-ai/blob/main/readmeai/conf/ignore_files.toml) to stop ignoring the following file extensions:
2929
- yaml, toml, txt, lock
3030

31+
### 🧹 Chore
32+
33+
- Regenerate all README files in the [examples](https://github.com/eli64s/readme-ai/tree/main/examples) directory to reflect the latest changes to the tool.
34+
3135
---
3236
## [v0.0.9] - *2023-09-19*
3337

‎README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,11 @@ This project is currently under development and has an opinionated configuration
6969
<table align="center">
7070
<tr>
7171
<td>
72+
<div align="center">
7273
<a href="https://youtu.be/pl-VcVfGbbk">
73-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/f0c5a038f63ae04b2d4452974676a92db42be8ce/examples/imgs/demo.png" alt="demo-video" />
74+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/f0c5a038f63ae04b2d4452974676a92db42be8ce/examples/imgs/demo.png" alt="demo-video" width="800"/>
7475
</a>
76+
</div>
7577
</td>
7678
</tr>
7779
</table>
@@ -84,15 +86,18 @@ This project is currently under development and has an opinionated configuration
8486
<td>
8587
<ul>
8688
<li>Use <i>readme-ai</i> directly in your browser with Streamlit! Zero installation, zero code!</li>
87-
<li><a href="https://readmeai.streamlit.app/">🛸 Take me to <i>readme-ai</i> on Streamlit!</a></li>
89+
<li>
90+
<a href="https://readmeai.streamlit.app/">🛸 Take me to <i>readme-ai</i> on Streamlit!</a></li>
8891
</ul>
8992
</td>
9093
</tr>
9194
<tr>
9295
<td>
96+
<div align="center">
9397
<a href="https://youtu.be/TrAPBpQ30Fw">
94-
<img src="https://github.com/eli64s/readme-ai/blob/main/examples/imgs/streamlit-demo.png?raw=true" alt="streamlit-demo-video" />
98+
<img src="https://github.com/eli64s/readme-ai/blob/main/examples/imgs/streamlit-demo.png?raw=true" alt="streamlit-demo-video" width="800"/>
9599
</a>
100+
</div>
96101
</td>
97102
</tr>
98103
</table>
@@ -114,7 +119,9 @@ This project is currently under development and has an opinionated configuration
114119
</tr>
115120
<tr>
116121
<td>
117-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/modules.png" alt="docs" />
122+
<div align="center">
123+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/modules.png" alt="docs" width="800"/>
124+
</div>
118125
</td>
119126
</tr>
120127
</table>
@@ -123,17 +130,19 @@ This project is currently under development and has an opinionated configuration
123130
<table align="center">
124131
<tr>
125132
<td>
126-
<h3>â—¦ Intro, Badges, & Table of Contents</h3>
133+
<h3>â—¦ Introduction, Badges, & Table of Contents</h3>
127134
<ul>
128135
<li>The OpenAI API is prompted to create a 1-sentence phrase describing your project.</li>
129136
<li>Project dependencies and metadata are visualized using <a href="https://shields.io/">Shields.io</a> badges.</li>
130-
<li>Badges are sorted by hex code, displayed from light to dark hues.</li>
137+
<!--<li>Badges are sorted by hex code, displayed from light to dark hues.</li>-->
131138
</ul>
132139
</td>
133140
</tr>
134141
<tr>
135142
<td>
136-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/header.png" alt="docs" />
143+
<div align="center">
144+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/header.png" width="800"/>
145+
</div>
137146
</td>
138147
</tr>
139148
</table>
@@ -156,12 +165,16 @@ This project is currently under development and has an opinionated configuration
156165
</tr>
157166
<tr>
158167
<td>
159-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/features.png" alt="features" />
168+
<div align="center">
169+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/features.png" alt="features" width="800"/>
170+
</div>
160171
</td>
161172
</tr>
162173
<tr>
163174
<td>
164-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/overview.png" alt="overview" />
175+
<div align="center">
176+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/overview.png" alt="overview" width="800"/>
177+
</div>
165178
</td>
166179
</tr>
167180
</table>
@@ -170,7 +183,9 @@ This project is currently under development and has an opinionated configuration
170183
<table align="center">
171184
<tr>
172185
<td>
173-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/tree.png" alt="tree" />
186+
<div align="center">
187+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/tree.png" alt="tree" width="800"/>
188+
</div>
174189
</td>
175190
</tr>
176191
</table>
@@ -193,7 +208,9 @@ This project is currently under development and has an opinionated configuration
193208
</tr>
194209
<tr>
195210
<td>
196-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/getting_started.png" alt="getting_started" />
211+
<div align="center">
212+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/getting_started.png" alt="getting_started" width="800"/>
213+
</div>
197214
</td>
198215
</tr>
199216
</table>
@@ -202,7 +219,9 @@ This project is currently under development and has an opinionated configuration
202219
<table align="center">
203220
<tr>
204221
<td>
205-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/closing.png" alt="contribute" />
222+
<div align="center">
223+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/imgs/closing.png" alt="contribute" width="800"/>
224+
</div>
206225
</td>
207226
</tr>
208227
</table>

0 commit comments

Comments
 (0)