Skip to content

Commit

Permalink
#4: Update documentation & Add dist to served files to NPM
Browse files Browse the repository at this point in the history
  • Loading branch information
7PH committed Sep 1, 2022
1 parent 1ac1599 commit f3c01f4
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="./assets/intro.gif">

PowerGlitch is a standalone library with no external dependencies. It leverages CSS animations to create a glitch effect on images. No canvas or DOM manipulations are needed. It weights around 1.8kb minified and gzipped and 4kb minified.<br>
PowerGlitch is a standalone library with no external dependencies. It leverages CSS animations to create a glitch effect on images. No canvas or DOM manipulations are needed. It weights less than 2kb minified and gzipped.<br>

Want to try it out? Check out the [demo](https://7ph.github.io/powerglitch/#/playground) 😊

Expand Down
2 changes: 1 addition & 1 deletion docs-src/src/views/HomeView.vue
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ onMounted(() => {
❓ Introduction
</h1>
<p class="mt-4">
PowerGlitch is a standalone library with no external dependencies. It leverages CSS animations to create a glitch effect on images. No canvas or DOM manipulations are needed. It weights around <b>1.8kb</b> minified and gzipped and <b>4kb</b> minified.<br>
PowerGlitch is a standalone library with no external dependencies. It leverages CSS animations to create a glitch effect on images. No canvas or DOM manipulations are needed. It weights less than <b>2kb</b> minified and gzipped.<br>
<br>
What are you waiting for?
<RouterLink
Expand Down
1 change: 1 addition & 0 deletions docs-src/src/views/UsageView.vue
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ PowerGlitch.glitch(
'div.glitch',
{
imageUrl: 'https://.../image.png',
playMode: 'always',
backgroundColor: 'transparent',
hideOverflow: true,
timing: {
Expand Down
37 changes: 19 additions & 18 deletions docs/assets/index.b5792558.js → docs/assets/index.b2848580.js

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
<link rel="icon" type="image/svg+xml" href="/powerglitch/favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>PowerGlitch - Glitch anything on the web</title>
<script type="module" crossorigin src="/powerglitch/assets/index.b5792558.js"></script>
<link rel="stylesheet" href="/powerglitch/assets/index.5af9e8a8.css">
<script type="module" crossorigin src="/powerglitch/assets/index.b2848580.js"></script>
<link rel="stylesheet" href="/powerglitch/assets/index.b2c1b130.css">
</head>
<body>
<div id="app"></div>
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
"test": "npm run lint && npm run size"
},
"files": [
"/lib"
"/lib",
"/dist"
],
"devDependencies": {
"@fortawesome/fontawesome-svg-core": "^6.1.1",
Expand Down

0 comments on commit f3c01f4

Please sign in to comment.