{"_id":"@alexneri/readability-ts","_rev":"8-a3d02f6e20bb6eba40a7f93d6799678c","name":"@alexneri/readability-ts","dist-tags":{"latest":"0.9.0"},"versions":{"0.7.0":{"name":"@alexneri/readability-ts","version":"0.7.0","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","_id":"@alexneri/readability-ts@0.7.0","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"homepage":"https://github.com/alexneri/readability-folder-ts","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"dist":{"shasum":"65154a9da7d2908fb2829aa9a7f6da206d2e9bde","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.7.0.tgz","fileCount":12,"integrity":"sha512-UYKyA/2lRCnzYV+Og+4bm37MTpCT5tiCJdhZzai3ms07wG/9ZIMZv+gQmtOmN7OYFhMgHkKjhE/XTrKjivl+Hw==","signatures":[{"sig":"MEMCHwTXrX6OGQi3Eqo0M5uupSGKYZfPpJq/vCR/Hmz+Q04CIFbqcpm+aflfdwHZB9TWkwajESptJ9IXIigDpZwj4Djg","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24354},"main":"readability.js","gitHead":"a4daa84427aadbc1276c9dbeef09b1f8f3db5af5","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"repository":{"url":"git+https://github.com/alexneri/readability-folder-ts.git","type":"git"},"_npmVersion":"10.5.0","description":"A CLI app that runs the Flesch-kincaid readability score recursively on all *.adoc files in the current directory.","directories":{},"_nodeVersion":"21.7.3","dependencies":{"undici-types":"^6.19.8"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^22.9.1"},"_npmOperationalInternal":{"tmp":"tmp/readability-ts_0.7.0_1732109800001_0.7628255829409187","host":"s3://npm-registry-packages"}},"0.7.1":{"name":"@alexneri/readability-ts","version":"0.7.1","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","_id":"@alexneri/readability-ts@0.7.1","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"homepage":"https://github.com/alexneri/readability-folder-ts","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"bin":{"readability-ts":"readability-ts"},"dist":{"shasum":"b4914ed545445082c2ac5fbbed0d76603b31c8cc","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.7.1.tgz","fileCount":12,"integrity":"sha512-0ldzLHoxGsMZDA2GbB+CZdMu5fKcq/eAaoIJUx2uqsAeY/gfo0cD8StHnxuJY48SeeFZauLHsYCpFP5bg1zdRQ==","signatures":[{"sig":"MEUCIEszbdicMNzL2F+ztqpwwSOkC3c7Ikr9usx31jvSbMkQAiEAufkZ8DIt9OtqpxrQhn0y6+BXjClA9ENvSYPeGItkZ2o=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24409},"main":"readability.js","gitHead":"a4daa84427aadbc1276c9dbeef09b1f8f3db5af5","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"repository":{"url":"git+https://github.com/alexneri/readability-folder-ts.git","type":"git"},"_npmVersion":"10.5.0","description":"A CLI app that runs the Flesch-kincaid readability score recursively on all *.adoc files in the current directory.","directories":{},"_nodeVersion":"21.7.3","dependencies":{"undici-types":"^6.19.8"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^22.9.1"},"_npmOperationalInternal":{"tmp":"tmp/readability-ts_0.7.1_1732115473837_0.8364748919011489","host":"s3://npm-registry-packages"}},"0.7.2":{"name":"@alexneri/readability-ts","version":"0.7.2","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","_id":"@alexneri/readability-ts@0.7.2","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"homepage":"https://github.com/alexneri/readability-folder-ts","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"bin":{"readability-ts":"readability-ts"},"dist":{"shasum":"efc13c09fe199f4f73b59e497311ebf9d84e568b","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.7.2.tgz","fileCount":12,"integrity":"sha512-l6YqDZ+whW1DHSe1rzcqvYgdQFrHRdovpQBHFo+ZhoqZTnwSb04se1h/4pA213VTR2EtxQ7JnoGqzeI+XcZcGw==","signatures":[{"sig":"MEYCIQDkYkBaXmoE4O/kqhH9a0fwdlZXpzFwRVSzl21iM8wSUwIhAL+16n2BzGKZwaI5NPC37mqKcAlG+csPs4v9PxiPUPHh","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24454},"main":"readability.js","gitHead":"a4daa84427aadbc1276c9dbeef09b1f8f3db5af5","scripts":{"test":"echo \"Error: no test specified\" && exit 1","readability-ts":"node readability.js"},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"repository":{"url":"git+https://github.com/alexneri/readability-folder-ts.git","type":"git"},"_npmVersion":"10.5.0","description":"A CLI app that runs the Flesch-kincaid readability score recursively on all *.adoc files in the current directory.","directories":{},"_nodeVersion":"21.7.3","dependencies":{"undici-types":"^6.19.8"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^22.9.1"},"_npmOperationalInternal":{"tmp":"tmp/readability-ts_0.7.2_1732115600611_0.21933345298429607","host":"s3://npm-registry-packages"}},"0.7.3":{"name":"@alexneri/readability-ts","version":"0.7.3","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","_id":"@alexneri/readability-ts@0.7.3","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"homepage":"https://github.com/alexneri/readability-folder-ts","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"bin":{"readability-ts":"readability.js"},"dist":{"shasum":"2a46a1d991efea977e3974bd68eb728e44c503f4","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.7.3.tgz","fileCount":12,"integrity":"sha512-6/c07N7ejqTrxq+Oa9YHjlMvYNsZwq316dvxKJLiNc0RoldQJmVkuVmLEQBL84YmEsTLXYUXc/1NjmmZqTUXVQ==","signatures":[{"sig":"MEUCIQC1vLTAwLg+61bT59ernPHoLSVGdB0necbP87QlM4igkAIgcVt2JZNGXs6Wg2do/3QRV6FbgK9SJzzN7oVc013LdM4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24454},"main":"readability.js","gitHead":"a4daa84427aadbc1276c9dbeef09b1f8f3db5af5","scripts":{"test":"echo \"Error: no test specified\" && exit 1","readability-ts":"node readability.js"},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"repository":{"url":"git+https://github.com/alexneri/readability-folder-ts.git","type":"git"},"_npmVersion":"10.5.0","description":"A CLI app that runs the Flesch-kincaid readability score recursively on all *.adoc files in the current directory.","directories":{},"_nodeVersion":"21.7.3","dependencies":{"undici-types":"^6.19.8"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^22.9.1"},"_npmOperationalInternal":{"tmp":"tmp/readability-ts_0.7.3_1732117483406_0.6373476311346573","host":"s3://npm-registry-packages"}},"0.7.4":{"name":"@alexneri/readability-ts","version":"0.7.4","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","_id":"@alexneri/readability-ts@0.7.4","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"homepage":"https://github.com/alexneri/readability-folder-ts","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"bin":{"readability-ts":"readability.js"},"dist":{"shasum":"a20f0a986ee6bd08301a656cb7fd5229ff246ff4","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.7.4.tgz","fileCount":12,"integrity":"sha512-naJmG5kXXJyEb3BtOacXC0gk9vFrhajWU135pZL/ex29a628bpp2Gv5YWjvJxUCUJnZZierPjuk3iJodZPjiLg==","signatures":[{"sig":"MEUCIGQB4IP8gWOZ0tZpQqINQ9cNCnkoz9TDCQXgl2svMQNWAiEA72jB0ITsxV3F2FmQgZzC020gIV8oxI+p6D+BOw6a0ro=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24482},"main":"readability.js","gitHead":"a4daa84427aadbc1276c9dbeef09b1f8f3db5af5","scripts":{"test":"echo \"Error: no test specified\" && exit 1","readability-ts":"node readability.js"},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"repository":{"url":"git+https://github.com/alexneri/readability-folder-ts.git","type":"git"},"_npmVersion":"10.5.0","description":"A CLI app that runs the Flesch-kincaid readability score recursively on all *.adoc files in the current directory.","directories":{},"_nodeVersion":"21.7.3","dependencies":{"undici-types":"^6.19.8"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0.0","@types/node":"^22.9.1"},"_npmOperationalInternal":{"tmp":"tmp/readability-ts_0.7.4_1732118258744_0.7083162024179384","host":"s3://npm-registry-packages"}},"0.7.5":{"name":"@alexneri/readability-ts","version":"0.7.5","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","_id":"@alexneri/readability-ts@0.7.5","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"homepage":"https://github.com/alexneri/readability-folder-ts","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"bin":{"readability-ts":"readability.js"},"dist":{"shasum":"7a4804e33720a24f3ceaf58a9024df0a0c09122b","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.7.5.tgz","fileCount":12,"integrity":"sha512-NA2q1VI9ze3XxwOAZNpKjAQl4NEizd8eAv6epvpQHBLlRcm9zOqcn6JNvBXiV669ayH3/7kgGaVqeNZa7QX+4A==","signatures":[{"sig":"MEQCIFYQ7VWKienwo8BdNWXd/guQyy0kup25VX4apchX70gfAiARI2/YO4wR9Goj2jLCi1E64SVmeaiqyZyPIrSIgJGYpQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24714},"main":"readability.js","gitHead":"a4daa84427aadbc1276c9dbeef09b1f8f3db5af5","scripts":{"test":"echo \"Error: no test specified\" && exit 1","readability-ts":"node readability.js"},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"repository":{"url":"git+https://github.com/alexneri/readability-folder-ts.git","type":"git"},"_npmVersion":"10.5.0","description":"A CLI app that runs the Flesch-kincaid readability score recursively on all *.adoc files in the current directory.","directories":{},"_nodeVersion":"21.7.3","dependencies":{"undici-types":"^6.19.8"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0.0","@types/node":"^22.9.1"},"_npmOperationalInternal":{"tmp":"tmp/readability-ts_0.7.5_1732118693600_0.9375494605656607","host":"s3://npm-registry-packages"}},"0.8.0":{"name":"@alexneri/readability-ts","version":"0.8.0","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","_id":"@alexneri/readability-ts@0.8.0","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"homepage":"https://github.com/alexneri/readability-folder-ts","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"bin":{"readability-ts":"readability.js"},"dist":{"shasum":"612f970ef3157ea81db6a4f1cb53986cc8266510","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.8.0.tgz","fileCount":13,"integrity":"sha512-M3vv5zxlKQrwsA4ip1IFZu8j3jGSl4+HYOFXqXZEHMdr2Sh7eyOnBm04TirhcNrJ3DDdlo84qPzrH8WMEkGjEQ==","signatures":[{"sig":"MEUCIQCegwyM8R61ZXM0VHrNS0ZyKdcHwI8/3wDE0MJxSI0l2wIgZrMH4Nb61ltKvBQuxozR2C1ij3BdYdApS7mTP+YN2hY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":73582},"main":"readability.js","gitHead":"dca83f47cd606766e88a7e37866b844e0e140d48","scripts":{"test":"echo \"Error: no test specified\" && exit 1","readability-ts":"node readability.js"},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"repository":{"url":"git+https://github.com/alexneri/readability-folder-ts.git","type":"git"},"_npmVersion":"10.5.0","description":"A CLI app that runs the Flesch-kincaid readability score recursively on all *.adoc files in the current directory.","directories":{},"_nodeVersion":"21.7.3","dependencies":{"undici-types":"^6.19.8"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0.0","@types/node":"^22.9.1"},"_npmOperationalInternal":{"tmp":"tmp/readability-ts_0.8.0_1732545180158_0.9790797636496487","host":"s3://npm-registry-packages"}},"0.9.0":{"name":"@alexneri/readability-ts","description":"A CLI app that runs the Flesch-Kincaid readability score recursively on AsciiDoc and Markdown files.","version":"0.9.0","scripts":{"build":"tsc && node -e \"require('fs').chmodSync('readability.js', 0o755)\"","prepublishOnly":"npm run build && npm test","test":"node --test test/*.test.js","readability-ts":"node readability.js"},"bin":{"readability-ts":"readability.js"},"main":"readability.js","repository":{"type":"git","url":"git+https://github.com/alexneri/readability-folder-ts.git"},"keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level","markdown","asciidoc"],"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"homepage":"https://readability-cli.sei.moe/","publishConfig":{"access":"public"},"devDependencies":{"@types/node":"^22.9.1","typescript":"^4.0.0"},"_id":"@alexneri/readability-ts@0.9.0","gitHead":"2e18af14d4c142ee6fcb1269439e2db0b07028f6","_nodeVersion":"22.22.3","_npmVersion":"10.9.8","dist":{"integrity":"sha512-/smLaYYbdxnckVElF/NCilpxm2reSOp8mHeif5vcaJDqQE3pBC+cD/lUmp71qooVk9hyzluNf5KOv9t7pm/XPQ==","shasum":"32a2bbb9cb1ea9ec065543db6b7a77c2c62a5eba","tarball":"https://registry.npmjs.org/@alexneri/readability-ts/-/readability-ts-0.9.0.tgz","fileCount":5,"unpackedSize":73759,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIAxJRQi/6ixJ/3avth2NRSG0PkTEZlNzKqIGNUuplkf1AiAUphCcqy+RsNfJJBiPMaNF26j2pEgeTKBlckjbPgZ3kg=="}]},"_npmUser":{"name":"alexneri","email":"crosse@sei.moe"},"directories":{},"maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/readability-ts_0.9.0_1781528065510_0.4579847612683696"},"_hasShrinkwrap":false}},"time":{"created":"2024-11-20T13:36:39.911Z","modified":"2026-06-15T12:54:25.753Z","0.7.0":"2024-11-20T13:36:40.205Z","0.7.1":"2024-11-20T15:11:14.038Z","0.7.2":"2024-11-20T15:13:20.772Z","0.7.3":"2024-11-20T15:44:43.587Z","0.7.4":"2024-11-20T15:57:39.077Z","0.7.5":"2024-11-20T16:04:53.804Z","0.8.0":"2024-11-25T14:33:00.338Z","0.9.0":"2026-06-15T12:54:25.650Z"},"bugs":{"url":"https://github.com/alexneri/readability-folder-ts/issues"},"author":{"name":"Alexander Neri"},"license":"GPL-3.0-or-later","homepage":"https://readability-cli.sei.moe/","keywords":["readability","flesch-kincaid","readability-score","readability-index","readability-test","readability-analysis","readability-assessment","readability-formula","readability-measure","readability-level","markdown","asciidoc"],"repository":{"type":"git","url":"git+https://github.com/alexneri/readability-folder-ts.git"},"description":"A CLI app that runs the Flesch-Kincaid readability score recursively on AsciiDoc and Markdown files.","maintainers":[{"name":"alexneri","email":"crosse@sei.moe"}],"readme":"# Readability Score Tester (Folder)\nA CLI app that runs the Flesch-Kincaid readability score recursively on AsciiDoc and Markdown files in a folder.\n\n## Overview\n\nThis tool scans a folder for documentation files, strips out code blocks and formatting, and computes a Flesch-Kincaid readability score. The higher the score, the easier the document is to read.\n\nSupported file types: `.adoc`, `.asciidoc`, `.md`, `.markdown`, `.mdx`.\n\n## Flow\n\n1. Recursively scan the folder (skipping `node_modules`, `.git`, `dist`, `build`, `coverage`, `.idea`, `.vscode`, and similar build/tooling directories).\n2. For every supported file, analyse the content:\n   1. Strip any header block the tool previously inserted (so re-runs do not stack headers).\n   2. Strip format-specific syntax: code blocks, headings, lists, emphasis, links, frontmatter, HTML, tables, etc.\n   3. Compute the Flesch-Kincaid readability score on the cleaned text.\n   4. Prepend a header block in the format native to the file:\n      * AsciiDoc files get `//` line comments.\n      * Markdown files get `<!-- ... -->` HTML comments.\n   5. Rating system:\n      * 90-100: 5th-6th grade level - Very easy to read.\n      * 80-89: 7th grade level - Fairly easy to read.\n      * 70-79: 8th & 9th grade - Plain English.\n      * 60-69: 10th-12th grade - Fairly difficult to read.\n      * 50-59: College - Difficult to read.\n      * 30-49: College grad - Very difficult to read.\n      * 0-29: Professional - Extremely difficult to read.\n3. Write a summary of all files and scores to `scores.txt` in the top-level folder.\n4. Display a progress bar while running (when stdout is a TTY).\n5. On completion, print: `Readability scores computed! Total files processed: <n> in <t> seconds.`\n\nFiles are processed concurrently (8 at a time) for speed.\n\n## Installation\n\nThere are two ways for you to install this tool:\n\n### Install via npm (Recommended)\n\n1. Run `npm install @alexneri/readability-ts -g`.\n\n### via this CLI\n\n1. Clone the repository: `git clone git@github.com:alexneri/readability-folder-ts.git` \n2. Open terminal.\n3. Navigate to the folder. \n4. Run `npm install` to install the dependencies.\n5. Run `npm link`\n\n## Usage\n\n```\nreadability-ts [path] [options]\n```\n\n* `path` — folder to scan (defaults to the current working directory).\n* `-n`, `--dry-run` — compute scores without modifying any files or writing `scores.txt`.\n* `-v`, `--version` — print the installed version and exit.\n* `-rn`, `--whats-new`, `--release-notes` — print release notes for the current version and exit.\n* `-h`, `--help` — show usage.\n\n### Examples\n\n```\nreadability-ts                 # scan the current folder\nreadability-ts ./docs          # scan a specific folder\nreadability-ts ./docs -n       # preview scores without writing anything\nreadability-ts --version       # print the installed version\nreadability-ts --whats-new     # print release notes for the current version\nreadability-ts --help          # print usage\n```\n\n### Re-running\n\nHeaders are wrapped in `readability-score:start` / `readability-score:end` sentinels, so re-running the tool replaces the existing header in place rather than stacking new ones. Files written by older (pre-0.9) versions of the tool are also detected and migrated on the next run.\n\n## License\n```GNU License\n\nThis program is free software licensed under GNU GPL v3 or later.\n\nYou have the freedom to:\n- Use this program for any purpose\n- Study and modify the source code\n- Share the program with others\n- Share your modifications with others\n\nIf you share this program or any modifications:\n- You must provide the source code\n- You must license it under GNU GPL v3\n- You must preserve copyright notices\n\nThis program comes with no warranty.\n\nFor the full license text see: GNU GPL v3\n```\n\nA donation is not required, but it is appreciated. If you find this program useful, please consider [sponsoring](https://github.com/sponsors/alexneri) me :) \n\n## Development\n\nRun the test suite (Node 18+; no extra devDependencies required):\n\n```\nnpm test\n```\n\nTests live in `test/` and use Node's built-in `node:test` runner. They\ncover both the pure scoring/parsing functions and the CLI flags via\nchild-process integration tests.\n\n## Roadmap\n\n* ~~Make this installable on npm~~ **DONE**\n* ~~Add Markdown support with proper comment syntax~~ **DONE**\n* ~~Idempotent re-runs~~ **DONE**\n* ~~Skip vendored/build directories by default~~ **DONE**\n* ~~Add a basic test suite~~ **DONE**\n* Add more tests\n* Add more documentation\n* Add more supported file formats\n* Add more supported languages\n* Add more supported readability tests\n\nFor feature requests, please open an [issue](https://github.com/alexneri/readability-folder-ts/issues) on the repository.\n\n## For further reading\n\n* Wikipedia Article: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests\n* Research Paper: https://psycnet.apa.org/doiLanding?doi=10.1037%2Fh0057532\n","readmeFilename":"README.md"}