Skip to content

Commit

Permalink
docs: Fix README.md for PyPi (#64)
Browse files Browse the repository at this point in the history
1. Images must use absolute, raw URLs so they resolve
2. The `<a name="..."></a>` doesn't work, but [this issue](
    pypa/readme_renderer#169) suggests that
    `<a id="..."></a>` may work. Giving it a try.
  • Loading branch information
bjchambers authored Feb 2, 2024
1 parent 80156a8 commit f877c3c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<a id="readme-top"></a>


<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/DewyKB/dewy">
<img src="images/logo.png" alt="Logo" width="160" height="160">
<img src="https://github.com/DewyKB/dewy/raw/main/images/logo.png" alt="Logo" width="160" height="160">
</a>

<h3 align="center">Dewy - The Knowledgebase for AI</h3>
Expand Down Expand Up @@ -36,7 +36,7 @@ Below is the typical architecture of an AI agent performing RAG.
Dewy handles all of the parts shown in brown so you can focus on your application -- the parts in green.

<p align="center">
<img src="images/app_architecture.png" alt="System architecture showing steps of RAG." width="600px">
<img src="https://github.com/DewyKB/dewy/raw/main/images/app_architecture.png" alt="System architecture showing steps of RAG." width="600px">
</p>

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand Down

0 comments on commit f877c3c

Please sign in to comment.