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: Update README #1665

Merged
merged 1 commit into from
Mar 21, 2025
Merged

Conversation

ianlewis
Copy link
Owner

@ianlewis ianlewis commented Mar 21, 2025

Description:

Update the README to reorder some of the sections, add a "Features" section, and add a section on installing as a Go tool dependency.

Related Issues:

Fixes #1640
Fixes #1655

Checklist:

  • Review the CONTRIBUTING.md documentation.
  • Add a reference to a related issue in the repository.
  • Add a description of the changes proposed in the pull request.
  • Add unit tests if applicable.
  • Update documentation if applicable.
  • Add a note in the CHANGELOG.md if applicable.

@ianlewis ianlewis linked an issue Mar 21, 2025 that may be closed by this pull request
Copy link

codecov bot commented Mar 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.61%. Comparing base (2df3e8b) to head (e086950).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1665   +/-   ##
=======================================
  Coverage   76.61%   76.61%           
=======================================
  Files          20       20           
  Lines        1364     1364           
=======================================
  Hits         1045     1045           
  Misses        233      233           
  Partials       86       86           
Files with missing lines Coverage Δ
cmd/todos/app.go 85.61% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ianlewis ianlewis force-pushed the 1640-docs-add-features-section-to-the-readme branch from f0de855 to 873fd41 Compare March 21, 2025 03:08
Signed-off-by: Ian Lewis <ian@ianlewis.org>
@ianlewis ianlewis force-pushed the 1640-docs-add-features-section-to-the-readme branch from 873fd41 to e086950 Compare March 21, 2025 03:09
@ianlewis ianlewis merged commit 4c739bb into main Mar 21, 2025
26 checks passed
@ianlewis ianlewis deleted the 1640-docs-add-features-section-to-the-readme branch March 21, 2025 03:13
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.

[docs] Instructions on adding as a Go tool [docs] Add "Features" section to the README
1 participant