Skip to content

docs: Fix README.md for PyPi #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bjchambers merged 1 commit into from
Feb 2, 2024
Merged

docs: Fix README.md for PyPi #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
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>

@bjchambers bjchambers Feb 1, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may separately want to create a table of contents allowing you to jump down to sections (in addition to up).



<!-- 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