Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
scriptex committed Feb 9, 2021
1 parent 6c573ca commit 8db1510
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
11 changes: 11 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
# These are supported funding model platforms

github: [scriptex]
patreon: atanas
open_collective: # Replace with a single Open Collective username
ko_fi: scriptex
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: scriptex
issuehunt: scriptex
otechie: # Replace with a single Otechie username
custom: ['paypal.me/scriptex']
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ After that, add references to all icons which were generated by `create-pwa`:

For more info about the favicons and meta tags below see [here](https://github.com/audreyr/favicon-cheat-sheet).

<details>
<summary>View favicons and meta tags</summary>

```html
<!-- All Apple touch icons for iPad, iPhone, iPod -->
<link rel="apple-touch-icon" sizes="57x57" href="favicons/apple-touch-icon-57x57.png" />
Expand Down Expand Up @@ -177,8 +180,13 @@ For more info about the favicons and meta tags below see [here](https://github.c
<meta name="msapplication-config" content="config.xml" />
```

</details>

4. (Optional) Add the following launch screens in the `head` of your HTML file(s):

<details>
<summary>View launch screens</summary>

```html
<!-- 12.9" iPad Pro Portrait -->
<link
Expand Down Expand Up @@ -405,6 +413,8 @@ For more info about the favicons and meta tags below see [here](https://github.c
/>
```

</details>

In order to have the launch screens shown on an iOS device you also need to tell the device it is dealing with a web app:

```html
Expand Down Expand Up @@ -514,6 +524,7 @@ setServiceWorker(appName);
[![Tweet](https://img.shields.io/badge/Tweet-Share_this_repository-blue.svg?style=flat-square&logo=twitter&color=38A1F3)](https://twitter.com/intent/tweet?text=Checkout%20this%20awesome%20software%20project%3A&url=https%3A%2F%2Fgithub.com%2Fscriptex%2Fcreate-pwa&via=scriptexbg&hashtags=software%2Cgithub%2Ccode%2Cawesome)
[![Donate](https://img.shields.io/badge/Donate-Support_me_on_PayPal-blue.svg?style=flat-square&logo=paypal&color=222d65)](https://www.paypal.me/scriptex)
[![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square&logo=patreon&color=e64413)](https://www.patreon.com/atanas)
[![Buy Me A Coffee](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi)](https://ko-fi.com/scriptex)

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "create-pwa",
"version": "2.3.0",
"version": "2.3.1",
"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",
Expand Down

0 comments on commit 8db1510

Please sign in to comment.