fix: 🔥 add package.json sections #10
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
Checklist
Description by Korbit AI
What change is being made?
Update the README.md with placeholder variables, add new npm scripts for automating tasks, and include metadata fields in package.json for repository information while also integrating doctoc for automatic generation of a Table of Contents in markdown files.
Why are these changes being made?
These changes enhance the template's usability by making it more customizable for users, streamline project setup with automated processes, and improve documentation management, thus ensuring higher code quality and consistency across projects. The inclusion of doctoc helps maintain an up-to-date Table of Contents, improving navigation within large markdown files, while the new npm scripts and package.json updates facilitate a smoother project management experience.