Merge pull request #10 from gr2m/tests

tests

Author: Stefan Buck

.github/workflows/ci.yml

@@ -2,22 +2,16 @@ name: CI
 on:
   push:
     branches:
-    - main
+      - main
 jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
 
-    - run: npm ci
+      - run: npm ci
 
-    - run: npm run build
+      - run: npm run build
 
-    - uses: mujo-code/puppeteer-headful@master
-      env:
-        PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
-        E2E_USER_NAME: ${{ secrets.E2E_USER_NAME }}
-        E2E_USER_PASSWORD: ${{ secrets.E2E_USER_PASSWORD }}
-      with:
-        args: npm test
+      - run: npm test

README.md

@@ -17,10 +17,57 @@ Use this action to convert issues into a unified JSON structure.
 
 ## Example
 
+Given an issue form
+
+```yml
+name: Bug
+description: Something is broken
+
+title: "Order Pizza"
+
+body:
+  - type: input
+    id: contact
+    attributes:
+      label: Your contact details
+    validations:
+      required: true
+
+  - type: input
+    id: what_happened
+    attributes:
+      label: What happened?
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: Version
+    validations:
+      required: true
+
+  - type: input
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+    validations:
+      required: true
+
+  - type: checkboxes
+    attributes:
+      label: What else?
+      options:
+        - label: Never give up
+        - label: Hot Dog is a Sandwich
+```
+
+And an issue body
+
 ```md
 ### Your contact details
 
-tomato@ilikepizza.com
+me@me.com
 
 ### What happened?
 
@@ -34,20 +81,21 @@ A bug happened!
 
 Chrome, Safari
 
-### Code of Conduct
+### What else?
 
-- [X] Never give up
-- [] Hot Dog is a Sandwich
+- [x] Never give up
+- [ ] Hot Dog is a Sandwich
 ```
 
+The actions output will be
 
 ```json
 {
-    "contact": "me@me.com",
-    "what_happened": "a bug happened!",
-    "version": "1.0.0",
-    "browsers": "chrome, safari",
-    "never_give_up": true,
-    "hot_dog_is_a_sandwich": false
+  "contact": "me@me.com",
+  "what_happened": "A bug happened!",
+  "version": "1.0.0",
+  "browsers": "Chrome, Safari",
+  "never_give_up": true,
+  "hot_dog_is_a_sandwich": false
 }
 ```