Skip to content
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.

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

Updated README with User Guide and Developer Guide sections #15

Merged
merged 3 commits into from
Jan 30, 2025

Conversation

vgodsoe
Copy link
Collaborator

@vgodsoe vgodsoe commented Jan 29, 2025

Closes #14
Updated Readme with User Guide and Dev sections.
Note: I added folder called "img" to store the Digest GIF, but if you'd rather a different structure, lmk!

@vgodsoe vgodsoe requested a review from pcolange January 29, 2025 19:01
Copy link
Collaborator

@pcolange pcolange left a comment

Choose a reason for hiding this comment

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

Looks great! See my comments below. Also, did we want to link to the blog?

@vgodsoe vgodsoe force-pushed the vgodsoe-update-readme branch from f2717a4 to 286cc94 Compare January 30, 2025 01:19
@vgodsoe vgodsoe requested a review from pcolange January 30, 2025 05:42
Copy link
Collaborator

@pcolange pcolange left a comment

Choose a reason for hiding this comment

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

LGTM! The gif isn't showing up on github but it does show up locally. If it still doesn't show up after it is merged into main then we can create another PR to address it. Something we may need to do is add a / to the path to show where the root is e.g. /src/digest/assets/gifs/digest..gif

@vgodsoe vgodsoe merged commit 720a88b into main Jan 30, 2025
7 checks passed
@vgodsoe vgodsoe deleted the vgodsoe-update-readme branch January 30, 2025 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add getting started content to README
2 participants