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

docs: Improve README Formatting #204

Merged
merged 4 commits into from
Feb 15, 2024
Merged

docs: Improve README Formatting #204

merged 4 commits into from
Feb 15, 2024

Conversation

ueman
Copy link
Contributor

@ueman ueman commented Jan 10, 2024

Link to the rendered README https://github.com/ueman/home_widget/blob/7f255317b5f69bdd880708de12e0cdf32897e5a4/README.md

This uses the <kbd> HTML tag to render menu paths a bit nicer, see
Screenshot 2024-01-10 at 07 32 58

I've also fixed and added syntax highlighting to a broken code fence.

@ueman
Copy link
Contributor Author

ueman commented Jan 22, 2024

@ABausG friendly ping to review these couple minor fixes

@ABausG ABausG changed the title Small improvements to the README docs: Improve README Formatting Jan 23, 2024
Copy link
Owner

@ABausG ABausG left a comment

Choose a reason for hiding this comment

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

Thanks for this! Love the kbd tags.

Just a small question regarding a line change you added where I believe something got mixed up

README.md Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (daea9c1) 100.00% compared to head (4d066a2) 100.00%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #204   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           69        73    +4     
=========================================
+ Hits            69        73    +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ABausG ABausG merged commit fe7c2fc into ABausG:main Feb 15, 2024
5 checks passed
@ueman ueman deleted the patch-1 branch February 15, 2024 20:26
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.

None yet

2 participants