Merge branch 'main' into jh/fix-cli

Rebilly · Jul 26, 2023 · 299878f · 299878f
2 parents d496249 + b26e844
commit 299878f
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
-# readability-reporter
+# Lexi
 
-This action reports readability scores and their changes for Markdown files in your pull requests, allowing you to quantify and track documentation improvements.
+Report a readability score for Markdown files in your pull requests, allowing you to quantify and track documentation improvements.
 
 <details>
   <summary>See example pull request comment</summary>
 **Overall readability score:** 20.18/100 (🟢 +0.97)
 
 File | Readability
 --- | ---
-[README.md](https://github.com/Rebilly/readability-reporter/blob/cce569da633a092c0a9b09bc1fe6d3df1b4dcb26/README.md "README.md") | 22.36 (🟢 +3.86)
+[README.md](https://github.com/Rebilly/lexi/blob/cce569da633a092c0a9b09bc1fe6d3df1b4dcb26/README.md "README.md") | 22.36 (🟢 +3.86)
 
 
 <details>
@@ -19,7 +19,7 @@ File | Readability
 
 File | Readability | FRE | GF | ARI | CLI | DCRS
 --- | --- | --- | --- | --- | --- | ---
-[README.md](https://github.com/Rebilly/readability-reporter/blob/cce569da633a092c0a9b09bc1fe6d3df1b4dcb26/README.md "README.md") | 22.36 | 44.11 | 16.67 | 28.7 | 11.85 | 7.66
+[README.md](https://github.com/Rebilly/lexi/blob/cce569da633a092c0a9b09bc1fe6d3df1b4dcb26/README.md "README.md") | 22.36 | 44.11 | 16.67 | 28.7 | 11.85 | 7.66
 &nbsp; | 🟢 +3.86 | 🟢 +2.03 | 🟢 +0.75 | 🟢 +2.2 | 🔴 -0.7 | 🟢 +0.01
 
 
@@ -48,9 +48,16 @@ Dale-Chall Readability | 4.9 (very easy read) to 9.9 (extremely difficult read)
 
 </details>
 
-## Readability scores
+## Readability score
 
-The [text-readability](https://github.com/clearnote01/readability) library is used to determine the complexity and ease of reading for your documentation files. These scores can be used as a guide to help you understand how changes may impact the readability of your documentation.
+Lexi calculates a readability score to estimate the complexity and ease of reading for your documentation files. The score can be used as a guide to help you understand how changes may impact the readability of your documentation.
+
+The score is a scaled combination of several readability tests:
+- [Flesch Reading Ease](https://en.wikipedia.org/wiki/Flesch_reading_ease)
+- [Gunning Fog Index](https://en.wikipedia.org/wiki/Gunning_fog_index)
+- [Automated Readability Index (ARI)](https://en.wikipedia.org/wiki/Automated_readability_index)
+- [Dale-Chall Readability Score](https://en.wikipedia.org/wiki/Dale%E2%80%93Chall_readability_formula)
+- [Coleman–Liau Index](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index)
 
 ## Usage
 
@@ -76,7 +83,7 @@ jobs:
         steps:
             - name: Checkout repo
               uses: actions/checkout@v2
-            - uses: Rebilly/readability-reporter@v1
+            - uses: Rebilly/lexi@v1
               with:
                   github-token: ${{ secrets.GITHUB_TOKEN }}
                   glob: '**/*.md'

diff --git a/action.yml b/action.yml
@@ -1,5 +1,5 @@
-name: Readability Reporter
-description: Comments readability scores on a pull request
+name: Lexi
+description: Report a readability score for Markdown files in your pull requests
 author: 'Rebilly Inc'
 branding:
   icon: edit

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
-    "name": "readability-reporter",
+    "name": "lexi",
     "version": "0.1",
-    "description": "Reports the readability scores for a pull request",
+    "description": "Report a readability score for Markdown files in your pull requests",
     "author": "Rebilly Inc",
-    "repository": "https://github.com/Rebilly/readability-reporter",
+    "repository": "https://github.com/Rebilly/lexi",
     "main": "lib/index.js",
     "scripts": {
         "build": "tsc",

diff --git a/playground/index.html b/playground/index.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Readability reporter playground</title>
+    <title>Lexi playground</title>
   </head>
   <body>
     <div id="app"></div>

diff --git a/playground/src/App.vue b/playground/src/App.vue
@@ -42,7 +42,7 @@ const scores = computed(() => {
 <template>
     <div class="row">
         <div class="column">
-            <h1>Readability playground</h1>
+            <h1>Lexi playground</h1>
         </div>
     </div>
     <div class="row">