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

Update README file #326

Merged
merged 5 commits into from
Jan 31, 2024
Merged

Update README file #326

merged 5 commits into from
Jan 31, 2024

Conversation

germartinez
Copy link
Member

Context

This PR:

  • Updates the README file content
  • Fixes some broken links (not really broken) highlighted by the linkcheker.

Copy link

github-actions bot commented Jan 31, 2024

Overall readability score: 66.63 (🔴 -0.18)

File Readability
glossary.md 55.47 (🟢 +0)
README.md 71.24 (🔴 -8.36)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
glossary.md 55.47 40.35 9.79 12.2 13.8 7.44
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
README.md 71.24 52.66 7.55 8.7 11.46 6.97
  🔴 -8.36 🔴 -10.8 🔴 -0.32 🔴 -2.2 🔴 -2.92 🟢 +0.4

Averages:

  Readability FRE GF ARI CLI DCRS
Average 66.63 56.86 9.46 10.18 10.89 7.19
  🔴 -0.18 🔴 -0.23 🔴 -0.01 🔴 -0.05 🔴 -0.06 🟢 +0.01
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@germartinez
Copy link
Member Author

Note: The previous image was not visible in light mode. Removing it for now.

Copy link
Collaborator

@tanay1337 tanay1337 left a comment

Choose a reason for hiding this comment

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

Thanks, @germartinez

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
germartinez and others added 2 commits January 31, 2024 10:56
@germartinez germartinez requested a review from tanay1337 January 31, 2024 09:56
@germartinez germartinez merged commit d2c4f30 into development Jan 31, 2024
3 checks passed
@germartinez germartinez deleted the readme branch January 31, 2024 10:46
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.

2 participants