Skip to content

Conversation

@mayconrfreitas
Copy link
Member

This pull request updates the documentation and versioning for the structforge project, focusing on clarifying usage instructions and improving examples for different operating systems and installation modes. It also bumps the package version for a new release.

Documentation improvements:

  • Added a new "Run modes" section to README.md with clear instructions and code examples for global, local, and development usage on Linux/macOS and Windows PowerShell. This includes tips for previewing, creating placeholders, and increasing verbosity.
  • Improved input and output examples in README.md by fixing indentation and directory structure formatting for clarity.
  • Enhanced the example project tree in README.md to show correct directory nesting and updated comments for better readability.

Versioning:

  • Updated the version in package.json from 1.0.1 to 1.0.3 to reflect new documentation and minor improvements.

@mayconrfreitas mayconrfreitas self-assigned this Oct 1, 2025
@mayconrfreitas mayconrfreitas merged commit 4f9cd38 into main Oct 1, 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