Skip to content

Conversation

@soderlind
Copy link
Owner

This pull request adds important project documentation and updates the README.md to reflect new features and configuration options for the WordPress Readme Preview VS Code extension. It introduces a changelog, a publishing checklist, and the full GPL-2.0 license text. The README.md is significantly expanded to showcase new features, clarify configuration options, and document the new WordPress.org-style preview theme and asset discovery.

Documentation and Licensing:

  • Added a comprehensive CHANGELOG.md following Keep a Changelog format, detailing all notable changes and version history.
  • Added a full LICENSE file with the complete GNU GPL v2.0-or-later text, clarifying the project's open-source licensing.
  • Introduced PUBLISH-CHECKLIST.md to guide maintainers through critical and recommended steps before publishing to the VS Code Marketplace.

README.md Feature and Configuration Updates:

  • Updated the feature list to include forced background modes, the new WordPress.org tabbed layout, and an accessible screenshot gallery.
  • Rewrote and expanded the configuration section with a settings table, detailed explanations for new options (like backgroundMode), and improved example snippets.
  • Added detailed documentation on the new wordpress-org theme, including tabbed interface features, plugin asset auto-discovery, and gallery accessibility.
  • Updated the license section in the README.md to match the new licensing, and improved end-of-file contributor guidance.

Publication setup:
- ✅ Add GPL-2.0-or-later license field to package.json
- ✅ Add repository, bugs, and homepage URLs
- ✅ Enhance keywords for better discoverability
- ✅ Add complete LICENSE file with GPL v2 terms
- ✅ Create publishing checklist and instructions

Still needed before publishing:
- Convert icon.svg to icon.png (128x128 pixels)
- Update publisher field to actual VS Code Marketplace ID
- Create PNG icon using provided instructions

Ready for: npm install -g vsce && vsce package && vsce publish
@soderlind soderlind merged commit 070f23f into main Oct 3, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants