Skip to content

Commit 467f5f7

Browse files
author
William Troup
authored
Merge pull request #14 from williamtroup/1.0.0
1.0.0
2 parents 53ea8fd + cbcf5f0 commit 467f5f7

35 files changed

+4962
-669
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
/.vscode
33
.DS_Store
44
*.nupkg
5+
/build
6+
/node_modules

‎.npmignore‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/.github
2+
/.vscode
3+
/test
4+
/build
5+
CODE_OF_CONDUCT.md
6+
CONTRIBUTING.md
7+
observe.js.nuspec
8+
PACK.sh
9+
PUBLISH.sh
10+
README_NUGET.md
11+
SECURITY.md
12+
SERVE.sh
13+
package-lock.json
14+
tsconfig.json
15+
tsup.build.config.ts
16+
tsup.build.esm.config.ts
17+
tsup.build.min.config.ts
18+
BUILD_INSTRUCTIONS.md
19+
*.nupkg

‎BUILD_INSTRUCTIONS.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Building Observe.js
2+
3+
Before getting started with Observe.js, please read through the following instructions:
4+
5+
6+
## Step 1: Install Packages:
7+
8+
Install the packages using the following NPM commands:
9+
10+
### 1. Install TypeScript:
11+
12+
```markdown
13+
npm install -g typescript
14+
```
15+
16+
### 2. Install tsup:
17+
18+
```markdown
19+
npm i tsup -D
20+
```
21+
22+
### 3. Install terser:
23+
24+
```markdown
25+
npm install terser -D
26+
```
27+
28+
### 4. Install swc/core (if ES5 is required):
29+
30+
```markdown
31+
npm install @swc/core -D
32+
```
33+
34+
35+
## Step 2: Build Project:
36+
37+
### 1. Full Build:
38+
39+
To build the TypeScript, run the following command:
40+
41+
```markdown
42+
npm run build-typescript
43+
```
44+
45+
To build the SASS, run the following command:
46+
47+
```markdown
48+
npm run build-sass
49+
```
50+
51+
To build the everything, run the following command:
52+
53+
```markdown
54+
npm run build
55+
```
56+
57+
### 2. Minimized Build:
58+
59+
To build the TypeScript, run the following command:
60+
61+
```markdown
62+
npm run build-minimized-typescript
63+
```
64+
65+
To build the SASS, run the following command:
66+
67+
```markdown
68+
npm run build-minimized-sass
69+
```
70+
71+
To build the everything, run the following command:
72+
73+
```markdown
74+
npm run build-minimized
75+
```
76+
77+
### 3. ESM Build:
78+
79+
To build the TypeScript, run the following command:
80+
81+
```markdown
82+
npm run build-typescript-esm
83+
```

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
Observe.js
33

44
[![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)
5-
[![npm](https://img.shields.io/badge/npmjs-v0.8.2-blue)](https://www.npmjs.com/package/jobserve.js)
6-
[![nuget](https://img.shields.io/badge/nuget-v0.8.2-purple)](https://www.nuget.org/packages/jObserve.js/)
5+
[![npm](https://img.shields.io/badge/npmjs-v1.0.0-blue)](https://www.npmjs.com/package/jobserve.js)
6+
[![nuget](https://img.shields.io/badge/nuget-v1.0.0-purple)](https://www.nuget.org/packages/jObserve.js/)
77
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Observe.js/blob/main/LICENSE.txt)
88
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Observe.js/discussions)
99
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://www.william-troup.com/)
1010
</h1>
1111

1212
> <p align="center">A lightweight JavaScript library that allows developers to keep track of changes to JavaScript objects and/or DOM elements.</p>
13-
> <p align="center">v0.8.2</p>
13+
> <p align="center">v1.0.0</p>
1414
<br />
1515
<br>
1616
1717
<h1>What features does Observe.js have?</h1>
1818

1919
- Zero-dependencies and extremely lightweight!
20-
- Exportable for use in other frameworks!
20+
- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
2121
- JS Object and HTML DOM Element watching!
2222
- Watch for specific property changes!
2323
- Cancel, Pause, and Resume support!

‎README_NUGET.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Observe.js v0.8.2
1+
# Observe.js v1.0.0
22

33
[![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)
4-
[![npm](https://img.shields.io/badge/npmjs-v0.8.2-blue)](https://www.npmjs.com/package/jobserve.js)
5-
[![nuget](https://img.shields.io/badge/nuget-v0.8.2-purple)](https://www.nuget.org/packages/jObserve.js/)
4+
[![npm](https://img.shields.io/badge/npmjs-v1.0.0-blue)](https://www.npmjs.com/package/jobserve.js)
5+
[![nuget](https://img.shields.io/badge/nuget-v1.0.0-purple)](https://www.nuget.org/packages/jObserve.js/)
66
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Observe.js/blob/main/LICENSE.txt)
77
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Observe.js/discussions)
88
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://www.william-troup.com/)
@@ -13,7 +13,7 @@
1313
## What features does Observe.js have?
1414

1515
- Zero-dependencies and extremely lightweight!
16-
- Exportable for use in other frameworks!
16+
- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
1717
- JS Object and HTML DOM Element watching!
1818
- Watch for specific property changes!
1919
- Cancel, Pause, and Resume support!

‎dist/observe.d.mts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
export { }

‎dist/observe.d.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
export { }

0 commit comments

Comments
 (0)