Literacy: A Figma pluigin for checking content for understandability

This Figma plugin evaluates content readability using the Flesch-Kincaid Grade Level scale. It also ensures proper sentence case formatting, helping designers maintain clarity and consistency in their content.

Features

• Readability Scoring: Analyzes text and provides a Flesch-Kincaid Grade Level to ensure accessibility.
• Sentence Case Enforcement: Flags text that doesn’t follow proper capitalization rules.
• Multi-select: Evaluate multiple text layers at once
• Real-Time Feedback: Instantly highlights readability issues in selected text layers.

---

Installation (Development)

To develop and test the plugin locally, follow these steps:

1. Clone the Repository

git clone https://github.com/alexofthewu/reading-level.git
cd reading-level

2. Install Dependencies

Ensure you have Node.js installed, then run:

npm install

3. Start the Development Server

npm run watch

4. Load the Plugin in Figma

1. Open Figma Desktop.
2. Go to Plugins > Development > Import Plugin from Manifest....
3. Select the manifest.json file in this repository.
4. The plugin should now be available under Plugins > Development.

---

Usage

1. Select any text layer(s) in your Figma design.
2. Open the plugin (Plugins > Literacy).
3. Select the text you want to analyze
4. View readability scores and corrections for capitalization.
5. Edit text to improve clarity based on the suggestions.

---

Figma Community

🔗 Install the Plugin from the Figma Community (Coming soon!)

---

Contributing

Contributions are welcome! Feel free to submit pull requests or open issues if you find any bugs or have feature requests.

Reporting Issues

If you encounter any problems, open an issue with a detailed description of the bug.

---

License

📜 MIT License. See LICENSE for details.

---

✅ Just replace the placeholders for the images and links, and you’re all set! Let me know if you need help adding badges or anything extra. 🚀