docs: improve README with badges, examples, and documentation #5

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.

Sign up for GitHub

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

Jump to bottom

Open

everettjf wants to merge 1 commit into main from feature/improved-readme-v2

Owner

everettjf commented Jan 31, 2026

Summary

This PR significantly improves the ScriptWidget README with better documentation structure, code examples, and visual hierarchy.

Changes

Badges: Added stars, platform, version, and license badges
Features Table: Added icon-labeled feature highlights
Code Examples: Included complete examples (Hello World, Weather, Todo)
Project Structure: Added directory tree visualization
Development Guide: Added setup and build instructions
API Documentation: Added data source APIs table
Platform Support: Added compatibility matrix

Target Branch: main
Reviewers: @everettjf


          docs: improve README with badges, examples, and documentation

a693582

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet