iLabUtk commited on
Commit
0a10667
Β·
verified Β·
1 Parent(s): f6ec77c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +17 -35
README.md CHANGED
@@ -1,35 +1,17 @@
1
- # πŸ“– Text Readability Analyzer
2
-
3
- ## πŸ“ About
4
- This application analyzes the readability of a given text using various readability metrics. These metrics help determine how easy or difficult a text is to read, making it useful for educators, writers, and researchers.
5
-
6
- ### **Readability Score Descriptions**
7
- - **Flesch Reading Ease**: A higher score means the text is easier to read.
8
- - **Flesch-Kincaid Grade Level**: Indicates the U.S. school grade required to understand the text.
9
- - **Gunning Fog Index**: Estimates the number of years of formal education needed.
10
- - **Automated Readability Index (ARI)**: Similar to Flesch-Kincaid but uses a different formula.
11
- - **SMOG Index**: Designed for healthcare and scientific texts.
12
- - **Coleman-Liau Index**: Uses character count instead of syllables.
13
- - **Dale-Chall Readability Score**: Considers familiar words to determine readability.
14
-
15
- ## πŸš€ Features
16
- βœ… **Real-time Text Analysis** – Enter text and get instant readability insights.
17
- βœ… **Multiple Readability Scores** – Compare different readability metrics.
18
- βœ… **Visual Representation** – Interactive charts to illustrate complexity.
19
- βœ… **Live Updates** – Analysis refreshes as you modify the text.
20
-
21
- ## 🎯 How to Use
22
- 1. **Enter or paste text** into the input box.
23
- 2. **View detailed readability scores** on the right.
24
- 3. **Interpret results** using the descriptions above.
25
- 4. **Use example text** by clicking the "Use Example Text" button.
26
-
27
- ## πŸ”— Try it on Hugging Face
28
- [![Hugging Face Space](https://img.shields.io/badge/πŸ€—%20Try%20it%20on%20Hugging%20Face-blue)](https://huggingface.co/spaces/Text_Analyzer)
29
-
30
- ## πŸ› οΈ Installation (For Local Use)
31
- To run the app locally, install dependencies and launch:
32
-
33
- ```bash
34
- pip install gradio textstat matplotlib
35
- python app.py
 
1
+ ---
2
+ title: "Text Readability Analyzer"
3
+ emoji: "πŸ“–"
4
+ color_from: "blue"
5
+ color_to: "purple"
6
+ sdk: "gradio"
7
+ sdk_version: "3.50.2"
8
+ app_file: "app.py"
9
+ license: "mit"
10
+ tags:
11
+ - readability
12
+ - text-analysis
13
+ - nlp
14
+ - gradio
15
+ - education
16
+ - linguistics
17
+ ---