Skip to content

Commit eb2a0b4

Browse files
committed
Fix links.
1 parent aaeb55c commit eb2a0b4

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div id="top">
22

33
<p align="center">
4-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-gradient.svg" alt="ReadmeAI Logo" width="85%">
4+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/aaeb55cf989d1f43f43e45d5219ae3e8c6be7435/docs/docs/assets/svg/logo-gradient.svg" alt="ReadmeAI Logo" width="85%">
55
</p>
66

77
<p align="center">
@@ -28,7 +28,7 @@
2828

2929
</div>
3030

31-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
31+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
3232

3333
## Quick Links
3434

@@ -43,7 +43,7 @@
4343
> [!IMPORTANT]
4444
> Explore the [Official Documentation][docs] for a complete list of features, customization options, and examples.
4545
46-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
46+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
4747

4848
## Introduction
4949

@@ -72,14 +72,14 @@ This project aims to streamline the process of creating and maintaining document
7272
[readmeai-streamlit-demo][streamlit-demo]
7373
-->
7474

75-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
75+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
7676

7777
## Features
7878

79-
Let's begin by exploring various customization options and styles supported by ReadmeAI:
80-
8179
### Customize Your README
8280

81+
Let's begin by exploring various customization options and styles supported by ReadmeAI:
82+
8383
<div align="left">
8484
<h6>Header Styles</h6>
8585
<table>
@@ -284,18 +284,18 @@ Let's begin by exploring various customization options and styles supported by R
284284

285285
<details><summary><strong>꩜ Expand to view more!</strong></summary><br>
286286

287-
| <h3>Project Introduction</h3> <ul><li>This section captures your project's essence and value proposition. </li><li>The prompt template used to generate this section can be viewed [here][prompts]. </li></ul> |
287+
| <h3>Project Introduction</h3> <ul><li>This section captures your project's essence and value proposition. </li><li>The prompt template used to generate this section can be viewed [here][prompts.toml]. </li></ul> |
288288
| :--- |
289289
| ![][project-overview] |
290290

291-
| <h3>Features Table</h3> <ul><li>Detailed feature breakdown and technical capabilities. </li><li>The prompt template used to generate this section can be viewed [here][prompts]. </li></ul> |
291+
| <h3>Features Table</h3> <ul><li>Detailed feature breakdown and technical capabilities. </li><li> The prompt template used to generate this section can be viewed [here][prompts.toml]. </li></ul> |
292292
| :--- |
293293
| ![][features-table] |
294294

295295
| <h3>Project Structure</h3> <ul><li>Visual representation of your project's directory structure. </li><li>The tree is generated using [pure Python][tree.py] and embedded in a code block. </li></ul> |
296296
| :--- |
297297
| ![][project-structure] |
298-
| <h3>Project Index</h3> <ul><li>Summarizes key modules of the project, which are also used as context for downstream [prompts][prompts]. </li></ul> |
298+
| <h3>Project Index</h3> <ul><li>Summarizes key modules of the project, which are also used as context for downstream [prompts.toml][prompts.toml]. </li></ul> |
299299
| ![][project-index] |
300300

301301
| <h3>Getting Started Guides</h3> <ul><li>Dependencies and system requirements are extracted from the codebase during preprocessing. </li><li>The [parsers][readmeai.parsers] handle most of the heavy lifting here. </li></ul> |
@@ -312,7 +312,7 @@ Let's begin by exploring various customization options and styles supported by R
312312

313313
</details>
314314

315-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
315+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
316316

317317
## Getting Started
318318

@@ -602,7 +602,7 @@ Run the `readmeai` CLI in a Docker container:
602602

603603
Try readme-ai directly in your browser on Streamlit Cloud, no installation required.
604604

605-
[<img align="center" src="https://static.streamlit.io/badges/streamlit_badge_black_white.svg" width="20%">][streamlit]
605+
[<img align="center" src="https://static.streamlit.io/badges/streamlit_badge_black_white.svg" width="20%">](https://readme-ai.streamlit.app/)
606606

607607
See the [readme-ai-streamlit][readme-ai-streamlit] repository on GitHub for more details about the application.
608608

@@ -648,7 +648,7 @@ If you installed the project from source with the bash script, run the following
648648

649649
</details>
650650

651-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
651+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
652652

653653
### Testing
654654

@@ -677,7 +677,7 @@ Using nox, test the app against Python versions `3.9`, `3.10`, `3.11`, and `3.12
677677
> [!TIP]
678678
> <sub>Nox is an automation tool for testing applications in multiple environments. This helps ensure your project is compatible with across Python versions and environments.</sub>
679679

680-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
680+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
681681

682682
## Configuration
683683

@@ -712,7 +712,7 @@ Visit the [Official Documentation][docs] for a complete guide on configuring and
712712

713713
</sub>
714714

715-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
715+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
716716

717717
## Example Gallery
718718

@@ -743,7 +743,7 @@ We invite developers to share their generated README files in our [Show & Tell][
743743
744744
Find additional README examples in our [examples directory][examples-directory] on GitHub.
745745
746-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
746+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
747747
748748
## Roadmap
749749
@@ -795,8 +795,6 @@ A big shoutout to the projects below for their awesome work and open-source cont
795795
</a>
796796
</div>
797797

798-
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="2px">
799-
800798
## 🎗 License
801799

802800
Copyright © 2023-2025 [readme-ai][readme-ai]. <br />
@@ -808,6 +806,8 @@ Released under the [MIT][license] license.
808806

809807
</div>
810808

809+
<img src="docs/docs/assets/svg/line-gradient.svg" alt="line break" width="100%" height="3px">
810+
811811
<!-- REFERENCE LINKS -->
812812
<!-- README-AI RESOURCES -->
813813
[readme-ai]: https://github.com/eli64s/readme-ai
@@ -875,14 +875,14 @@ Released under the [MIT][license] license.
875875

876876
<!-- EXAMPLES -->
877877
<!-- FEATURES -->
878-
[project-overview]: docs/docs/assets/img/project-overview/introduction.png
879-
[features-table]: docs/docs/assets/img/features/features.png
880-
[project-structure]: docs/docs/assets/img/project-structure/project-structure.png
881-
[project-index]: docs/docs/assets/img/project-structure/project-index.png
882-
[installation-steps]: docs/docs/assets/img/getting-started/installation-steps.png
883-
[usage-guides]: docs/docs/assets/img/getting-started/usage-guides.png
884-
[community-and-support]: docs/docs/assets/img/community/community-and-support.png
885-
[contributing-guidelines]: docs/docs/assets/img/community/contributing-guidelines.png
878+
[project-overview]: https://github.com/eli64s/readme-ai/blob/main/https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-overview/introduction.png?raw=true
879+
[features-table]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/features/features.png
880+
[project-structure]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-structure.png
881+
[project-index]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-index.png
882+
[installation-steps]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/installation-steps.png
883+
[usage-guides]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/usage-guides.png
884+
[community-and-support]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/community-and-support.png
885+
[contributing-guidelines]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/contributing-guidelines.png
886886
[readmeai.parsers]: https://github.com/eli64s/readme-ai/tree/main/readmeai/parsers
887887
[tree.py]: https://github.com/eli64s/readme-ai/blob/main/readmeai/generators/tree.py
888888
[prompts.toml]: https://github.com/eli64s/readme-ai/blob/main/readmeai/config/settings/prompts.toml

docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="hero-section">
33
<div class="hero-content">
44
<div class="logo-container">
5-
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-gradient.svg"
5+
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/aaeb55cf989d1f43f43e45d5219ae3e8c6be7435/docs/docs/assets/svg/logo-gradient.svg"
66
alt="readme-ai">
77
</div>
88
<h2 class="tagline">

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "readmeai"
3-
version = "0.6.0-rc.1"
3+
version = "0.6.0-rc.2"
44
description = "Automated README file generator, powered by AI."
55
authors = ["Eli Salamie <egsalamie@gmail.com>"]
66
license = "MIT"

0 commit comments

Comments
 (0)