Skip to content

Commit

Permalink
Merge pull request #25 from williamtroup/2.0.0
Browse files Browse the repository at this point in the history
2.0.0
  • Loading branch information
William Troup authored Jul 5, 2024
2 parents 7488db9 + 1f84dc2 commit 65df6d4
Show file tree
Hide file tree
Showing 99 changed files with 6,870 additions and 2,972 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/.vs
/.vscode
.DS_Store
*.nupkg
*.nupkg
/build
/node_modules
19 changes: 19 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/.github
/.vscode
/test
/build
CODE_OF_CONDUCT.md
CONTRIBUTING.md
journey.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
83 changes: 83 additions & 0 deletions BUILD_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Building Journey.js v2.0.0

Before getting started with Journey.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
```
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
Journey.js

[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Journey.js%2C%20a%20free%20JavaScript%journey%builder&url=https://github.com/williamtroup/Journey.js&hashtags=javascript,html,journey,guide)
[![npm](https://img.shields.io/badge/npmjs-v1.7.2-blue)](https://www.npmjs.com/package/jjourney.js)
[![nuget](https://img.shields.io/badge/nuget-v1.7.2-purple)](https://www.nuget.org/packages/jJourney.js/)
[![npm](https://img.shields.io/badge/npmjs-v2.0.0-blue)](https://www.npmjs.com/package/jjourney.js)
[![nuget](https://img.shields.io/badge/nuget-v2.0.0-purple)](https://www.nuget.org/packages/jJourney.js/)
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Journey.js/blob/main/LICENSE.txt)
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Journey.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, easy-to-use JavaScript library to create interactive, customizable, accessible guided tours across your websites or web apps!</p>
> <p align="center">v1.7.2</p>
> <p align="center">v2.0.0</p>
<br />
![Journey.js](docs/images/main.png)
Expand All @@ -21,7 +21,7 @@ Journey.js
<h1>What features does Journey.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!
- Full API available via public functions.
- Fully styled in CSS/SASS and compatible with the Bootstrap library.
- Full CSS theme support (using :root variables, with a default dark-mode theme).
Expand Down Expand Up @@ -125,6 +125,13 @@ npm install jjourney.js
```

Or, you can download the latest zipped up version [here](https://www.william-troup.com/journey-js/download.html).

Or, you can also use the following CDN links:

```markdown
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.min.js
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.js.min.css
```
<br>
<br>

Expand Down
15 changes: 11 additions & 4 deletions README_NUGET.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Journey.js v1.7.2
# Journey.js v2.0.0

[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Journey.js%2C%20a%20free%20JavaScript%journey%builder&url=https://github.com/williamtroup/Journey.js&hashtags=javascript,html,journey,guide)
[![npm](https://img.shields.io/badge/npmjs-v1.7.2-blue)](https://www.npmjs.com/package/jjourney.js)
[![nuget](https://img.shields.io/badge/nuget-v1.7.2-purple)](https://www.nuget.org/packages/jJourney.js/)
[![npm](https://img.shields.io/badge/npmjs-v2.0.0-blue)](https://www.npmjs.com/package/jjourney.js)
[![nuget](https://img.shields.io/badge/nuget-v2.0.0-purple)](https://www.nuget.org/packages/jJourney.js/)
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Journey.js/blob/main/LICENSE.txt)
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Journey.js/discussions)
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://www.william-troup.com/)
Expand All @@ -13,7 +13,7 @@
## What features does Journey.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!
- Full API available via public functions.
- Fully styled in CSS/SASS and compatible with the Bootstrap library.
- Full CSS theme support (using :root variables, with a default dark-mode theme).
Expand Down Expand Up @@ -110,6 +110,13 @@ npm install jjourney.js

Or, you can download the latest zipped up version [here](https://www.william-troup.com/journey-js/download.html).

Or, you can also use the following CDN links:

```markdown
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.min.js
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.js.min.css
```


## How do I get started?

Expand Down
2 changes: 2 additions & 0 deletions dist/journey.d.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

export { }
2 changes: 2 additions & 0 deletions dist/journey.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

export { }
Loading

0 comments on commit 65df6d4

Please sign in to comment.