Merge pull request #14 from williamtroup/1.0.0

1.0.0
williamtroup · Jul 16, 2024 · 467f5f7 · 467f5f7
2 parents 53ea8fd + cbcf5f0
commit 467f5f7
Show file tree

Hide file tree

Showing 35 changed files with 4,962 additions and 669 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,5 @@
 /.vscode
 .DS_Store
 *.nupkg
+/build
+/node_modules
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,19 @@
+/.github
+/.vscode
+/test
+/build
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+observe.js.nuspec
+PACK.sh
+PUBLISH.sh
+README_NUGET.md
+SECURITY.md
+SERVE.sh
+package-lock.json
+tsconfig.json
+tsup.build.config.ts
+tsup.build.esm.config.ts
+tsup.build.min.config.ts
+BUILD_INSTRUCTIONS.md
+*.nupkg
diff --git a/BUILD_INSTRUCTIONS.md b/BUILD_INSTRUCTIONS.md
@@ -0,0 +1,83 @@
+# Building Observe.js
+
+Before getting started with Observe.js, please read through the following instructions:
+
+
+## Step 1: Install Packages:
+
+Install the packages using the following NPM commands:
+
+### 1. Install TypeScript:
+
+```markdown
+npm install -g typescript
+```
+
+### 2. Install tsup:
+
+```markdown
+npm i tsup -D
+```
+
+### 3. Install terser:
+
+```markdown
+npm install terser -D
+```
+
+### 4. Install swc/core (if ES5 is required):
+
+```markdown
+npm install @swc/core -D
+```
+
+
+## Step 2: Build Project:
+
+### 1. Full Build:
+
+To build the TypeScript, run the following command:
+
+```markdown
+npm run build-typescript
+```
+
+To build the SASS, run the following command:
+
+```markdown
+npm run build-sass
+```
+
+To build the everything, run the following command:
+
+```markdown
+npm run build
+```
+
+### 2. Minimized Build:
+
+To build the TypeScript, run the following command:
+
+```markdown
+npm run build-minimized-typescript
+```
+
+To build the SASS, run the following command:
+
+```markdown
+npm run build-minimized-sass
+```
+
+To build the everything, run the following command:
+
+```markdown
+npm run build-minimized
+```
+
+### 3. ESM Build:
+
+To build the TypeScript, run the following command:
+
+```markdown
+npm run build-typescript-esm
+```
diff --git a/README.md b/README.md
@@ -2,22 +2,22 @@
 Observe.js
 
 [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Observe.js%2C%20a%20free%20JavaScript%observe%builder&url=https://github.com/williamtroup/Observe.js&hashtags=javascript,html,observe)
-[![npm](https://img.shields.io/badge/npmjs-v0.8.2-blue)](https://www.npmjs.com/package/jobserve.js)
-[![nuget](https://img.shields.io/badge/nuget-v0.8.2-purple)](https://www.nuget.org/packages/jObserve.js/)
+[![npm](https://img.shields.io/badge/npmjs-v1.0.0-blue)](https://www.npmjs.com/package/jobserve.js)
+[![nuget](https://img.shields.io/badge/nuget-v1.0.0-purple)](https://www.nuget.org/packages/jObserve.js/)
 [![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Observe.js/blob/main/LICENSE.txt)
 [![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Observe.js/discussions)
 [![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://www.william-troup.com/)
 </h1>
 
 > <p align="center">A lightweight JavaScript library that allows developers to keep track of changes to JavaScript objects and/or DOM elements.</p>
-> <p align="center">v0.8.2</p>
+> <p align="center">v1.0.0</p>
 <br />
 <br>
 
 <h1>What features does Observe.js have?</h1>
 
 - Zero-dependencies and extremely lightweight!
-- Exportable for use in other frameworks!
+- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
 - JS Object and HTML DOM Element watching!
 - Watch for specific property changes!
 - Cancel, Pause, and Resume support!

diff --git a/README_NUGET.md b/README_NUGET.md
@@ -1,8 +1,8 @@
-# Observe.js v0.8.2
+# Observe.js v1.0.0
 
 [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Observe.js%2C%20a%20free%20JavaScript%observe%builder&url=https://github.com/williamtroup/Observe.js&hashtags=javascript,html,observe)
-[![npm](https://img.shields.io/badge/npmjs-v0.8.2-blue)](https://www.npmjs.com/package/jobserve.js)
-[![nuget](https://img.shields.io/badge/nuget-v0.8.2-purple)](https://www.nuget.org/packages/jObserve.js/)
+[![npm](https://img.shields.io/badge/npmjs-v1.0.0-blue)](https://www.npmjs.com/package/jobserve.js)
+[![nuget](https://img.shields.io/badge/nuget-v1.0.0-purple)](https://www.nuget.org/packages/jObserve.js/)
 [![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Observe.js/blob/main/LICENSE.txt)
 [![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Observe.js/discussions)
 [![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://www.william-troup.com/)
@@ -13,7 +13,7 @@
 ## What features does Observe.js have?
 
 - Zero-dependencies and extremely lightweight!
-- Exportable for use in other frameworks!
+- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
 - JS Object and HTML DOM Element watching!
 - Watch for specific property changes!
 - Cancel, Pause, and Resume support!

diff --git a/dist/observe.d.mts b/dist/observe.d.mts
@@ -0,0 +1,2 @@
+
+export {  }
diff --git a/dist/observe.d.ts b/dist/observe.d.ts
@@ -0,0 +1,2 @@
+
+export {  }