Skip to content

Commit

Permalink
Updated README and documentation to list pnpm as downloading option a…
Browse files Browse the repository at this point in the history 
…nd improved build scripts
  • Loading branch information
@jalbam
jalbam committed Mar 22, 2023
1 parent 64b35c7 commit c96913c
Show file tree
Hide file tree
Showing 372 changed files with 418 additions and 374 deletions.
8 changes: 7 additions & 1 deletion 3_crossbrowdy_create_zip.bat
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,16 @@ setlocal
del %~dp0TempZipScript.ps1
endlocal

REM Deletes previous dist zip file (if exists):
IF EXIST "crossbrowdy.com\files\CrossBrowdy.zip" (
echo.
echo Deleting previous zip file...
del crossbrowdy.com\files\CrossBrowdy.zip
)

REM Copies the ZIP file to the web site folder:
echo.
echo Copying ZIP file to the web site folder...
del crossbrowdy.com\files\CrossBrowdy.zip
copy _zip_temp\CrossBrowdy.zip crossbrowdy.com\files\CrossBrowdy.zip

echo Removing temp folder...
Expand Down
9 changes: 8 additions & 1 deletion 4_crossbrowdy_create_zip_dist.bat
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,17 @@ setlocal
endlocal


REM Deletes previous dist zip file (if exists):
IF EXIST "crossbrowdy.com\files\CrossBrowdy.dist.zip" (
echo.
echo Deleting previous zip file...
del crossbrowdy.com\files\CrossBrowdy.dist.zip
)


REM Copies the ZIP file to the web site folder:
echo.
echo Copying ZIP file to the web site folder...
del crossbrowdy.com\files\CrossBrowdy.dist.zip
copy dist\CrossBrowdy.dist.zip crossbrowdy.com\files\CrossBrowdy.dist.zip


Expand Down
8 changes: 7 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,18 @@ npm i crossbrowdy
```


## Using **pnpm**:
```
pnpm i crossbrowdy
```


## Using **Bower**:
```
bower install jalbam/crossbrowdy --save
```

**Note**: [Yarn](https://yarnpkg.com/en/package/crossbrowdy "CrossBrowdy's Yarn package"), [npm](https://www.npmjs.com/package/crossbrowdy "CrossBrowdy's npm package") and Bower will also download the [API documentation](https://crossbrowdy.com/api/ "CrossBrowdy API documentation").
**Note**: [Yarn](https://yarnpkg.com/en/package/crossbrowdy "CrossBrowdy's Yarn package"), [npm](https://www.npmjs.com/package/crossbrowdy "CrossBrowdy's npm package"), pnpm and Bower will also download the [API documentation](https://crossbrowdy.com/api/ "CrossBrowdy API documentation").


# Hotlinking
Expand Down
8 changes: 7 additions & 1 deletion README_website/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,18 @@ npm i crossbrowdy
```


## Using **pnpm**:
```
pnpm i crossbrowdy
```


## Using **Bower**:
```
bower install jalbam/crossbrowdy --save
```

**Note**: [Yarn](https://yarnpkg.com/en/package/crossbrowdy "CrossBrowdy's Yarn package"), [npm](https://www.npmjs.com/package/crossbrowdy "CrossBrowdy's npm package") and Bower will also download the [API documentation](https://crossbrowdy.com/api/ "CrossBrowdy API documentation").
**Note**: [Yarn](https://yarnpkg.com/en/package/crossbrowdy "CrossBrowdy's Yarn package"), [npm](https://www.npmjs.com/package/crossbrowdy "CrossBrowdy's npm package"), pnpm and Bower will also download the [API documentation](https://crossbrowdy.com/api/ "CrossBrowdy API documentation").


# Hotlinking
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Arrays.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6628,7 +6628,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioDetector.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1867,7 +1867,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFile.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7587,7 +7587,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFileCache.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14978,7 +14978,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFileSprites.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16807,7 +16807,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFileSpritesPool.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14672,7 +14672,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFile_API.AAPI.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5590,7 +5590,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFile_API.ACMP.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5821,7 +5821,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFile_API.SM2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5590,7 +5590,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_AudioFile_API.WAAPI.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6163,7 +6163,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Canvas.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4693,7 +4693,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5680,7 +5680,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Collisions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7075,7 +7075,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Configuration.CrossBase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13025,7 +13025,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Configuration.CrossBrowdy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -756,7 +756,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Controllers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2994,7 +2994,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Controllers_Proprietary.WII.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Controllers_Proprietary.WII_U.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2539,7 +2539,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Controllers_Proprietary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.AmbientLight.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -905,7 +905,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.Battery.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3289,7 +3289,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.Location.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2316,7 +2316,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.Motion.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1625,7 +1625,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.Orientation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2157,7 +2157,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.Proximity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -945,7 +945,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.Vibration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Device.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Elements.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18678,7 +18678,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Events.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2518,7 +2518,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_GraphicSprites.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19691,7 +19691,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_GraphicSpritesScene.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6719,7 +6719,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Keyboard.chars.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6210,7 +6210,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Keyboard.extended.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13693,7 +13693,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
2 changes: 1 addition & 1 deletion crossbrowdy.com/_html/_doc/api/CB_Keyboard.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3751,7 +3751,7 @@ <h4 class="modal-title">Search results</h4>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>

on Tue Mar 21st 2023
on Wed Mar 22nd 2023

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
Loading

0 comments on commit c96913c

Please sign in to comment.