Skip to content

Commit e8a10bb

Browse files
authored
Optimize Build Package Size by Updating .npmignore (#5)
* Fix: Exclude examples directory from version control To keep the repository clean and focused on the source code, this commit updates .gitignore and .npmignore to exclude the examples directory. The examples directory contains real-world usage examples of the library, which are not necessary for the package functionality but useful for developers. By excluding these files from version control, we minimize the package size and streamline the development process. * Update: API Reference in README to Reflect Revised API Structure This commit updates the API Reference section of the README.md file to accurately reflect the changes made to the WWTimer API structure. It clarifies the usage of the start(), pause(), and destroy() methods according to the new implementation where the callback function and interval are specified at the instance creation. This change ensures that the documentation is in sync with the current API design, making it easier for users to understand how to implement and use the WWTimer in their projects. * v1.0.2 * Update: Optimize package size by refining .npmignore Updated the .npmignore file to exclude additional files and directories such as .github/, .eslintrc.js, husky/, src/, and rollup.config.mjs along with banner.jpg. This change aims to further reduce the size of the build package, ensuring a more efficient distribution and installation process.
1 parent 6ef430a commit e8a10bb

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

.npmignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
.gitignore
22
.git/
3+
.github/
4+
.eslintrc.js
5+
husky/
6+
src/
37
node_modules/
48
npm-debug.log
59
examples/
10+
rollup.config.mjs
11+
banner.jpg

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![WW Timer](./banner.jpg)
1+
![WW Timer](https://github.com/univdev/ww-timer/raw/master/banner.jpg)
22
# WW Timer
33
WW Timer is a highly accurate timer library for web browsers.
44

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ww-timer",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"keywords": [
55
"web worker",
66
"timer",

0 commit comments

Comments
 (0)