Skip to content

Commit

Permalink
Update package metadata (#114)
Browse files Browse the repository at this point in the history
  • Loading branch information
scriptex committed Sep 9, 2022
1 parent 6725ec7 commit 082351d
Show file tree
Hide file tree
Showing 6 changed files with 110 additions and 171 deletions.
6 changes: 1 addition & 5 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
name: Build

on:
push:
branches: [master]
pull_request:
branches: [master]
on: [push, pull_request]

jobs:
build:
Expand Down
48 changes: 20 additions & 28 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,52 +6,44 @@ yarn-debug.log*
yarn-error.log*

# Dependency directory
node_modules/
node_modules

# Misc
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
.github
ehthumbs.db
Thumbs.db

# EditorConfig
# Config folders and files
.github
_config.yml
_.config.yml
.editorconfig

# Git
.gitignore
.gitattributes

# CI
.travis.yml

# lock files
yarn.lock

# Prettier
.prettierrc
.gitignore
.nvmrc
.prettierignore

# Config files
.prettierrc
.stylelintignore
.stylelintrc
.travis.yml
.whitesource
renovate.json
_config.yml
_.config.yml

# Misc
create-pwa.sketch
create-pwa.svg
icon.png
launch.png
renovate.json
tsconfig.json
tslint.json
yarn.lock

# Tests
favicons
icons
favicons
launch-screens
config.xml
*.appcache
create-pwa.svg
icon.png
launch.png
manifest.json
service-worker.js
*.appcache
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ node_js:
install:
- yarn
script:
- yarn pwa
- yarn test
167 changes: 55 additions & 112 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,18 @@

</div>

# Create PWA (Create a Progressive Web Application)
[![Travis CI](https://travis-ci.com/scriptex/create-pwa.svg?branch=master)](https://travis-ci.com/scriptex/create-pwa)
[![Github Build](https://github.com/scriptex/create-pwa/workflows/Build/badge.svg)](https://github.com/scriptex/create-pwa/actions?query=workflow%3ABuild)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/34d3d75710534dc6a38c3584a1dcd068)](https://www.codacy.com/gh/scriptex/create-pwa/dashboard?utm_source=github.com&utm_medium=referral&utm_content=scriptex/create-pwa&utm_campaign=Badge_Grade)
[![Codebeat Badge](https://codebeat.co/badges/d765a4c8-2c0e-44f2-89c3-fa364fdc14e6)](https://codebeat.co/projects/github-com-scriptex-create-pwa-master)
[![CodeFactor Badge](https://www.codefactor.io/repository/github/scriptex/create-pwa/badge)](https://www.codefactor.io/repository/github/scriptex/create-pwa)
[![DeepScan grade](https://deepscan.io/api/teams/3574/projects/5257/branches/40799/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799)
[![Analytics](https://ga-beacon-361907.ew.r.appspot.com/UA-83446952-1/github.com/scriptex/create-pwa/README.md?pixel)](https://github.com/scriptex/create-pwa/)

[![npm][npm-version-img]][npm-version-url] [![MIT license][license-img]][license-url] [![Twitter][twitter-img]][twitter-url] [![Analytics][analytics-img]][analytics-url]
# Create PWA (Create a Progressive Web Application)

> Easily create a Progressive Web Application
[![All issues on Github][github-issues-img]][github-issues-url]
[![Open issues on Github][github-open-issues-img]][github-open-issues-url]
[![Closed issues on Github][github-closed-issues-img]][github-closed-issues-url]
[![Latest Github gag][github-tag-img]][github-tag-url]
[![GitHub last commit][last-commit-img]][last-commit-url]

[![Weekly downloads on NPM][npm-downloads-weekly-img]][npm-url]
[![Monthly downloads on NPM][npm-downloads-monthly-img]][npm-url]
[![Yearly downloads on NPM][npm-downloads-yearly-img]][npm-url]
[![Total downloads on NPM][npm-downloads-total-img]][npm-url]

[![Githib build status][github-status-img]][github-status-url]
[![Combined Github checks][github-checks-img]][github-checks-url]
![Publish size][publish-size-img]
![Top language][github-top-language-img]
![Used languages count][github-languages-img]
[![Renovate App Status][renovateapp-img]][renovateapp-url]
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]

## About

`create-pwa` is a module for quick scaffolding and producing of progressive web applications.
Expand All @@ -37,6 +24,21 @@

`create-pwa` can be used with existing applications or can be the first thing one does when starting a new app.

## Visitor stats

![GitHub stars](https://img.shields.io/github/stars/scriptex/create-pwa?style=social)
![GitHub forks](https://img.shields.io/github/forks/scriptex/create-pwa?style=social)
![GitHub watchers](https://img.shields.io/github/watchers/scriptex/create-pwa?style=social)
![GitHub followers](https://img.shields.io/github/followers/scriptex?style=social)

## Code stats

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/scriptex/create-pwa)
![GitHub repo size](https://img.shields.io/github/repo-size/scriptex/create-pwa?style=plastic)
![GitHub language count](https://img.shields.io/github/languages/count/scriptex/create-pwa?style=plastic)
![GitHub top language](https://img.shields.io/github/languages/top/scriptex/create-pwa?style=plastic)
![GitHub last commit](https://img.shields.io/github/last-commit/scriptex/create-pwa?style=plastic)

## Dependencies

In order to use this module, you must have NodeJS installed and NPM or Yarn available.
Expand Down Expand Up @@ -538,7 +540,7 @@ setServiceWorker(appName);

## LICENSE

[MIT][license-url]
MIT

---

Expand Down Expand Up @@ -601,94 +603,35 @@ setServiceWorker(appName);
---

<div align="center">
Support and sponsor my work:<br /><br />

[![Tweet][tweet-img]][tweet-url]

[![Donate on Paypal][paypal-img]][paypal-url]
[![Donate on Revolut][revolut-img]][revolut-url]
[![Become a Patron][patreon-img]][patreon-url]
[![Buy Me A Coffee][ko-fi-img]][ko-fi-url]
[![Donate on Liberapay][liberapay-img]][liberapay-url]

![Donate Bitcoin][bitcoin-wallet]<br />
![Donate Etherium][etherium-wallet]<br />
![Donate Shiba Inu][shiba-inu-wallet]
Support and sponsor my work:
<br />
<br />
<a href="https://twitter.com/intent/tweet?text=Checkout%20this%20awesome%20developer%20profile%3A&url=https%3A%2F%2Fgithub.com%2Fscriptex&via=scriptexbg&hashtags=software%2Cgithub%2Ccode%2Cawesome" title="Tweet">
<img src="https://img.shields.io/badge/Tweet-Share_my_profile-blue.svg?logo=twitter&color=38A1F3" />
</a>
<a href="https://paypal.me/scriptex" title="Donate on Paypal">
<img src="https://img.shields.io/badge/Donate-Support_me_on_PayPal-blue.svg?logo=paypal&color=222d65" />
</a>
<a href="https://revolut.me/scriptex" title="Donate on Revolut">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/revolut.json" />
</a>
<a href="https://patreon.com/atanas" title="Become a Patron">
<img src="https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?logo=patreon&color=e64413" />
</a>
<a href="https://ko-fi.com/scriptex" title="Buy Me A Coffee">
<img src="https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi" />
</a>
<a href="https://liberapay.com/scriptex/donate" title="Donate on Liberapay">
<img src="https://img.shields.io/liberapay/receives/scriptex?label=Donate%20on%20Liberapay&logo=liberapay" />
</a>

<a href="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json" title="Donate Bitcoin">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json" />
</a>
<a href="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json" title="Donate Etherium">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json" />
</a>
<a href="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json" title="Donate Shiba Inu">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json" />
</a>
</div>

[npm-version-img]: https://badgen.net/npm/v/create-pwa?icon=npm
[npm-version-url]: https://www.npmjs.com/package/create-pwa
[license-img]: https://badgen.net/npm/license/create-pwa
[license-url]: https://github.com/scriptex/create-pwa/blob/master/LICENSE
[twitter-url]: https://twitter.com/scriptexbg
[twitter-img]: https://badgen.net/twitter/follow/scriptexbg?icon=twitter&color=1da1f2&cache=300
[github-tag-img]: https://badgen.net/github/tag/scriptex/create-pwa?icon=github
[github-tag-url]: https://github.com/scriptex/create-pwa/releases/latest
[github-checks-img]: https://badgen.net/github/checks/scriptex/create-pwa?icon=github
[github-checks-url]: https://github.com/scriptex/create-pwa
[github-issues-img]: https://badgen.net/github/issues/scriptex/create-pwa?icon=github
[github-issues-url]: https://github.com/scriptex/create-pwa/issues
[github-open-issues-img]: https://badgen.net/github/open-issues/scriptex/create-pwa?icon=github
[github-open-issues-url]: https://github.com/scriptex/create-pwa/issues?q=is%3Aopen+is%3Aissue
[github-closed-issues-img]: https://badgen.net/github/closed-issues/scriptex/create-pwa?icon=github
[github-closed-issues-url]: https://github.com/scriptex/create-pwa/issues?q=is%3Aissue+is%3Aclosed
[last-commit-img]: https://badgen.net/github/last-commit/scriptex/create-pwa?icon=github
[last-commit-url]: https://github.com/scriptex/create-pwa/commits/master
[analytics-img]: https://ga-beacon.appspot.com/UA-83446952-1/github.com/scriptex/create-pwa/README.md
[analytics-url]: https://github.com/scriptex/create-pwa/
[npm-downloads-weekly-img]: https://badgen.net/npm/dw/create-pwa?icon=npm
[npm-downloads-monthly-img]: https://badgen.net/npm/dm/create-pwa?icon=npm
[npm-downloads-yearly-img]: https://badgen.net/npm/dy/create-pwa?icon=npm
[npm-downloads-total-img]: https://badgen.net/npm/dt/create-pwa?icon=npm
[npm-url]: https://www.npmjs.com/package/create-pwa
[tweet-img]: https://img.shields.io/badge/Tweet-Share_this_repository-blue.svg?style=flat-square&logo=twitter&color=38A1F3
[tweet-url]: https://twitter.com/intent/tweet?text=Checkout%20this%20awesome%20developer%20profile%3A&url=https%3A%2F%2Fgithub.com%2Fscriptex&via=scriptexbg&hashtags=software%2Cgithub%2Ccode%2Cawesome
[paypal-img]: https://img.shields.io/badge/Donate-Support_me_on_PayPal-blue.svg?style=flat-square&logo=paypal&color=222d65
[paypal-url]: https://www.paypal.me/scriptex
[revolut-img]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/revolut.json
[revolut-url]: https://revolut.me/scriptex
[patreon-img]: https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square&logo=patreon&color=e64413
[patreon-url]: https://www.patreon.com/atanas
[ko-fi-img]: https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi
[ko-fi-url]: https://ko-fi.com/scriptex
[liberapay-img]: https://img.shields.io/liberapay/receives/scriptex.svg?logo=liberapay
[liberapay-url]: https://liberapay.com/scriptex
[issuehunt-img]: https://raw.githubusercontent.com/BoostIO/issuehunt-materials/master/v1/issuehunt-shield-v1.svg
[issuehunt-url]: https://issuehunt.io/r/scriptex/create-pwa
[publish-size-img]: https://badgen.net/packagephobia/publish/create-pwa
[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green?cache=300
[renovateapp-url]: https://renovatebot.com
[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green?cache=300
[prs-welcome-url]: https://github.com/scriptex/create-pwa/pulls
[github-status-img]: https://badgen.net/github/status/scriptex/create-pwa?icon=github
[github-status-url]: https://github.com/scriptex/create-pwa/actions/workflows/build.yml
[github-languages-img]: https://img.shields.io/github/languages/count/scriptex/create-pwa
[github-top-language-img]: https://img.shields.io/github/languages/top/scriptex/create-pwa
[bitcoin-wallet]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json
[etherium-wallet]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json
[shiba-inu-wallet]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json

[social-website-url]: https://atanas.info
[social-website-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/logo.svg
[social-email-url]: mailto:[email protected]
[social-email-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/email.svg
[social-linkedin-url]: https://www.linkedin.com/in/scriptex/
[social-linkedin-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linkedin.svg
[social-github-url]: https://github.com/scriptex
[social-github-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/github.svg
[social-gitlab-url]: https://gitlab.com/scriptex
[social-gitlab-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/gitlab.svg
[social-twitter-url]: https://twitter.com/scriptexbg
[social-twitter-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/twitter.svg
[social-npm-url]: https://www.npmjs.com/~scriptex
[social-npm-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/npm.svg
[social-youtube-url]: https://www.youtube.com/user/scriptex
[social-youtube-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/youtube.svg
[social-stackoverflow-url]: https://stackoverflow.com/users/4140082/atanas-atanasov
[social-stackoverflow-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/stackoverflow.svg
[social-codepen-url]: https://codepen.io/scriptex/
[social-codepen-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codepen.svg
[social-codersrank-url]: https://profile.codersrank.io/user/scriptex
[social-codersrank-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codersrank.svg
[social-linktree-url]: https://linktr.ee/scriptex
[social-linktree-img]: https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linktree.svg
41 changes: 24 additions & 17 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,37 +1,44 @@
{
"name": "create-pwa",
"version": "2.5.0",
"version": "2.6.0",
"description": "Easily create a progressive web app",
"scripts": {
"pwa": "src/index.js --icon=\"./icon.png\" --launch=\"./launch.png\" --icons=false --app-cache=false --manifest=false --favicons=false --service-worker=false --launch-screens=false",
"test": "tape test.js"
},
"bin": {
"create-pwa": "./src/index.js"
},
"keywords": [
"PWA",
"CLI",
"progressive web app",
"manifest",
"web app",
"service worker",
"favicon generator"
"Web App",
"Manifest",
"Webmanifest",
"PWA Generator",
"Service Worker",
"Favicon Generator",
"Progressive Web App"
],
"main": "src/index.js",
"repository": "[email protected]:scriptex/create-pwa.git",
"homepage": "https://atanas.info/projects/create-pwa.html",
"bugs": {
"url": "https://github.com/scriptex/create-pwa/issues",
"email": "[email protected]"
"email": "[email protected]"
},
"author": "Atanas Atanasov <[email protected]> (https://atanas.info)",
"license": "MIT",
"author": "Atanas Atanasov <[email protected]> (https://atanas.info)",
"funding": "https://github.com/sponsors/scriptex",
"main": "src/index.js",
"repository": {
"type": "git",
"url": "github:scriptex/create-pwa"
},
"scripts": {
"pwa": "src/index.js --icon=\"./icon.png\" --launch=\"./launch.png\" --icons=false --app-cache=false --manifest=false --favicons=false --service-worker=false --launch-screens=false",
"test": "tape test.js"
},
"dependencies": {
"png-to-ico": "2.1.7",
"sharp": "0.31.0",
"yargs": "17.5.1"
},
"devDependencies": {
"tape": "5.6.0"
},
"bin": {
"create-pwa": "./src/index.js"
}
}
Loading

0 comments on commit 082351d

Please sign in to comment.