Skip to content

v2.1.5

Choose a tag to compare

View all tags
@1abcdefggs 1abcdefggs released this 25 Jul 08:24
v2.1.5
648eaf7

🚀 Release Notes (v2.1.5)

This release focuses on a massive overhaul of our documentation and developer experience (DX), ensuring that both first-time users and core contributors have the smoothest experience possible.

There are no breaking changes or new CLI features in this release. It is a 100% safe, documentation-only update!

📚 Documentation

  • Purpose-Driven Installation Guide: Completely redesigned the installation sections in README.md and USAGE.md. The guide is now perfectly structured based on user intent (e.g., "Execute directly with npx" vs "Install globally with npm").
  • Fully Responsive UI: Removed legacy Markdown tables from the documentation in favor of a modern, responsive layout ([Heading + Code Block + Bullet points]). This completely eliminates horizontal scrolling issues on mobile devices and npmjs.com, and works perfectly with GitHub's native "Copy" buttons.
  • npm vs npx Clarification: Added a beginner-friendly "Prerequisite" section that clearly explains the core differences between package management (npm) and package execution (npx), eliminating a common source of confusion.
  • IDE "Gotchas" Resolved: Explicitly documented the command not found pitfall when installing locally (without -g) inside VS Code, providing exact workarounds (npx splist or npm run).

🛡️ Developer Experience & CI

  • Implementation of a Robust Release Workflow: A new contributor guide outlining a five-step error-free release process.

  • Addition of Status Badges: Dynamic GitHub Actions (public status) and GitHub repository badges have been added to the beginning of the README. This provides users with real-time information about the project's health, increasing credibility.

Other features include local environment cl etc.

Full Changelog: v2.1.4...v2.1.5

Assets 2
Loading