We need a README for pwa and pwa_extras. This has been on my list. It is mainly a matter of consolidating the various sources of information from the issue queues.

CommentFileSizeAuthor
#2 README.md-file-3095135-2.patch3.14 KBsahana _n

Comments

AlexBorsody created an issue. See original summary.

sahana _n’s picture

sahana _n commented
Status: Active » Needs review
StatusFileSize
new README.md-file-3095135-2.patch3.14 KB

README.md file added, please review

alexborsody’s picture

alexborsody commented

This is mostly cut and paste documentation from D7, our module is different, which is one of the main reasons we need to document it from information in the queue. For example in the D8 module we don't set this attribute display: standalone. It's still a todo #3070058: Document how to specify the orientation parameter via alter hook, can you go through the issue queue and make sure the information is relevant to the D8 version. There should be lots of links to the relevant issues.

alexborsody’s picture

alexborsody commented

Also since we add manifest images through the UI not a hook in D8 so there's no need to have info about the D7 hook in here #3093677: hook_pwa_manifest_alter() is not working.

christophweber’s picture

christophweber commented
Status: Needs review » Needs work

Thanks for the inital patch @Sahana _N, much appreciated!
As pointed out by Alex, it needs a few tweaks, but those should be simple enough.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

here are a few formatting nitpicks. Thanks for the contribution!

  1. +++ b/README.md
@@ -0,0 +1,90 @@
+  even in uncertain network conditions.

    lines after bullet points should have hanging indents 

  2. +++ b/README.md
@@ -0,0 +1,90 @@
+   user’s home screen.

    Is there a space at the beginning of line 22 

  3. +++ b/README.md
@@ -0,0 +1,90 @@
+  The main benefit of this module is the use of Service Worker for caching and

    Is there a space at the beginning of line 33 

  4. +++ b/README.md
@@ -0,0 +1,90 @@
+ offline capabilities. Once the Service Worker is active, page loading is faster:

    Line break at 80 characters 

  5. +++ b/README.md
@@ -0,0 +1,90 @@
+   for further information.

    Is there a space at the beginning of line 59 

  6. +++ b/README.md
@@ -0,0 +1,90 @@
+(This hook is D7 ONLY, D8 you may upload a manifest icon at /admin/config/pwa/settings).

    Line break after 80 characters

alexborsody’s picture

alexborsody commented
Status: Needs work » Fixed
alexborsody’s picture

alexborsody commented
Status: Fixed » Closed (fixed)