v1.0.4

WW Timer Project Version 1.0.4 Release Notes

We're thrilled to announce the release of WW Timer Project version 1.0.4. This release focuses on enhancing the npm package's integrity and cleanliness, specifically by refining how we exclude non-essential files and directories. We've also continued our commitment to improving project documentation and management. Here are the highlights of what's new in version 1.0.4.

🔄 Updates and Refinements

• Update .npmignore to Correctly Exclude .husky Directory: In our ongoing efforts to optimize our package, we've corrected the .npmignore configuration to properly exclude the .husky directory. This update prevents the inclusion of development-specific Husky configuration files in the npm package, ensuring that the package remains lightweight and focused solely on production needs.

🐛 Fixes

• Precise Exclusion of Development Directories: This version includes adjustments to our .gitignore and .npmignore files to ensure that all development-specific directories and files, such as .husky/, are correctly ignored. This refinement helps maintain a clean and efficient repository and package, avoiding unnecessary clutter and potential confusion for end-users.

📖 Documentation Updates

• While this release primarily focuses on package optimization, we continue to prioritize clear and accurate documentation. Efforts to keep our documentation in sync with the project's current state ensure that users and contributors alike can easily understand and work with WW Timer.

Version 1.0.4 embodies our commitment to delivering a more streamlined and efficient development tool. By making targeted adjustments to our npm package configuration, we aim to enhance the overall user experience, ensuring that the WW Timer Project remains a reliable and easy-to-use solution for developers.

A huge thank you goes out to all our users and contributors for your continued support and feedback. Your input is invaluable in driving the WW Timer Project forward, and we're excited about the future improvements and features that lie ahead.

v1.0.3

WW Timer Project Version 1.0.3 Release Notes

We're excited to announce the release of WW Timer Project version 1.0.3. This update brings further optimizations to the build package size, along with continued enhancements to our documentation and repository management. Below are the key updates included in this version.

🔄 Updates and Refinements

• Optimize Build Package Size by Updating .npmignore (#5): We've made additional refinements to the .npmignore file, now excluding more files and directories such as .github/, .eslintrc.js, husky/, src/, and rollup.config.mjs, along with banner.jpg. This optimization further reduces the build package size, improving efficiency in distribution and installation.

🐛 Fixes

• Exclude Examples Directory from Version Control: Continuing our efforts to maintain a clean and streamlined repository, this version further updates .gitignore and .npmignore to exclude the examples directory. This action reduces the package size and focuses on the essential source code.

📖 Documentation Updates

• Update API Reference in README to Reflect Revised API Structure: We have updated the API Reference section of the README.md to better align with the WWTimer API's current structure. This update provides clearer guidance on using the start(), pause(), and destroy() methods, ensuring our documentation is accurate and helpful for users.

Version 1.0.3 reflects our ongoing commitment to improving the WW Timer Project through thoughtful optimizations and clear, comprehensive documentation. By making these adjustments, we aim to provide a more efficient and user-friendly experience for all developers who utilize the WW Timer in their projects.

Thank you to all our users and contributors for your support and feedback, which continue to drive the project forward. We look forward to delivering even more improvements in future updates.

v1.0.2

WW Timer Project Version 1.0.2 Release Notes

We're pleased to announce the release of WW Timer Project version 1.0.2. This minor update focuses on enhancing the community's ability to contribute to the project and ensuring that our documentation accurately reflects the latest API changes. Here's a summary of what's new and improved.

✨ New Features

• Contribution Guidelines and Templates for Issues & PRs: With the addition of a CONTRIBUTING.md file and new templates for both issues and pull requests, we aim to make the contribution process more structured and accessible. These tools are designed to help contributors provide clear, concise information, streamlining project development and issue resolution.

📖 Documentation Updates

• Updated README for Clearer API Reference: The API Reference section of our README.md has been updated to better reflect the recent adjustments to the WWTimer's API structure. These updates provide clearer instructions and examples, making it easier for users to implement and benefit from the WWTimer in their projects.

🐛 Fixes

• Exclusion of Examples Directory from Version Control: To maintain a clean and focused repository, the examples directory has now been excluded from version control. This directory, while valuable for demonstrating practical uses of the WWTimer, is not essential for the functionality of the package itself. This change reduces the overall package size and simplifies the repository structure.

This update underscores our commitment to improving the WW Timer Project through community feedback and contributions. We believe these changes will make for a more welcoming and efficient development environment and look forward to further enhancements in the future.

Thank you for your continued support and contributions to the WW Timer Project!

v1.0.1

WW Timer Project Version 1.0.1 Release Notes

We're pleased to announce the release of version 1.0.1 for the WW Timer project. This minor update brings a quality-of-life improvement aimed at optimizing the repository and package size. Below you'll find details on the changes made in this release.

🐛 Fixes

• Exclude Examples Directory from Version Control (#2): To maintain a cleaner and more focused repository, we've updated .gitignore and .npmignore to exclude the examples directory. This directory, while useful for demonstrating real-world applications of our library, is not necessary for the package's functionality. By removing it from version control, we reduce the package size, making it lighter and faster to download, and streamline the development process by focusing on the source code.

This update is part of our ongoing efforts to enhance the usability and efficiency of the WW Timer project. We recommend all users to update to version 1.0.1 to benefit from these improvements.

Thank you for your continued support and feedback, which help us improve. Stay tuned for future updates!

v1.0.0

WW Timer Project Version 1.0.0 Release Notes

We're excited to announce the release of version 1.0.0 of our project. This major update includes several new features, improvements, and breaking changes aimed at enhancing functionality, code quality, and deployment processes. Below is a summary of the significant changes included in this release.

✨ New Features

• Created WW Timer: Introduced the WW Timer feature to our project, providing a robust timing solution.
• Rollup Configuration for ES Module Bundling: Added a rollup.config.js file to configure the bundling process, ensuring efficient bundling for use with modern JavaScript module systems.
• Workflow for Deploying Package to NPM with Version Confirmation: Introduced a new GitHub Actions workflow to automate the deployment process to NPM, requiring manual version confirmation for intentional and verified deployments.

💥 Breaking Changes

• Changed 'play' Method Name to 'start': To improve code readability and make the method's purpose more intuitive, we have renamed the play method in the WWTimer class to start. This change affects how the method is called and will require updates in your code where the method is used.

🔄 Updates and Refinements

• Updated for NPM Deploy: Made necessary updates to prepare for NPM deployment.
• Defined Keywords: Specified keywords to improve the discoverability of our package on NPM.
• Build Script Update and Rollup as a Dev Dependency: Simplified the "build" script to use Rollup configuration, and added Rollup as a development dependency to ensure a consistent build process.
• Enhanced NPM Deployment Workflow: Enhanced the GitHub Actions workflow for NPM deployment by specifying the registry-url and including the NODE_AUTH_TOKEN for secure publishing.

🛠 Other Improvements

• Added ESLint Rules: Introduced new ESLint rules to maintain high code quality.
• Added Husky: Implemented Husky to enforce pre-commit hooks for code quality checks.
• Removed Deploy Script from package.json: Streamlined the project's scripts by removing the "deploy" script, shifting towards utilizing external CI/CD pipelines for deployments.
• Updated Deployment Command in GitHub Actions: Changed the deployment command to use npm publish directly, ensuring a smoother and more direct publishing process.

📚 Documentation

• API Changes Reflected: Updated documentation to reflect the API changes, ensuring that the documentation remains accurate and helpful.

🔒 License

• Added LICENSE File: Included a LICENSE file to clearly state the terms under which our project can be used.

We encourage all users to update to the latest version to take advantage of these improvements and changes. Please note the breaking changes and adjust your implementations accordingly. Thank you for your support, and we look forward to further enhancing our project in future releases.