Update documentation

library-pals · Dec 19, 2023 · 5158097 · 5158097
1 parent f6dfa2c
commit 5158097
Showing 1 changed file with 37 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -60,12 +60,17 @@ on:
       tags:
         description: Add tags to categorize the book. Separate each tag with a comma. Optional.
         type: string
-      # If you do not submit date-started or date-finished, the book status will be set to "want to read"
-      date-started:
-        description: Date you started the book (YYYY-MM-DD). Optional.
-        type: string
-      date-finished:
-        description: Date you finished the book (YYYY-MM-DD). Optional.
+      bookStatus:
+        description: What is the status of the book? Required.
+        required: true
+        type: choice
+        options:
+          - "want to read"
+          - "started"
+          - "finished"
+          - "abandoned"
+      date:
+        description: Date to record the status of the book (YYYY-MM-DD). Leave blank for today. Optional.
         type: string
 
 # Set up the steps to run the action
@@ -132,12 +137,17 @@ on:
       tags:
         description: Add tags to categorize the book. Separate each tag with a comma. Optional.
         type: string
-      # If you do not submit date-started or date-finished, the book status will be set to "want to read"
-      date-started:
-        description: Date you started the book (YYYY-MM-DD). Optional.
-        type: string
-      date-finished:
-        description: Date you finished the book (YYYY-MM-DD). Optional.
+      bookStatus:
+        description: What is the status of the book? Required.
+        required: true
+        type: choice
+        options:
+          - "want to read"
+          - "started"
+          - "finished"
+          - "abandoned"
+      date:
+        description: Date to record the status of the book (YYYY-MM-DD). Leave blank for today. Optional.
         type: string
 
 # Set up the steps to run the action
@@ -233,12 +243,17 @@ on:
       tags:
         description: Add tags to categorize the book. Separate each tag with a comma. Optional.
         type: string
-      # If you do not submit date-started or date-finished, the book status will be set to "want to read"
-      date-started:
-        description: Date you started the book (YYYY-MM-DD). Optional.
-        type: string
-      date-finished:
-        description: Date you finished the book (YYYY-MM-DD). Optional.
+      bookStatus:
+        description: What is the status of the book? Required.
+        required: true
+        type: choice
+        options:
+          - "want to read"
+          - "started"
+          - "finished"
+          - "abandoned"
+      date:
+        description: Date to record the status of the book (YYYY-MM-DD). Leave blank for today. Optional.
         type: string
 
 # Set up the steps to run the action
@@ -294,12 +309,14 @@ To trigger the action, [create a workflow dispatch event](https://docs.github.co
     "notes": "", // Notes about the book. Optional.
     "rating": "", // Rate the book. Optional. Default: `unrated`.
     "tags": "", // Add tags to categorize the book. Separate each tag with a comma. Optional.
-    "date-started": "", // Date you started the book (YYYY-MM-DD). Optional.
-    "date-finished": "", // Date you finished the book (YYYY-MM-DD). Optional.
+    "bookStatus": "", // Required. What is the status of the book? Required.
+    "date": "", // Date to record the status of the book (YYYY-MM-DD). Leave blank for today. Optional.
   }
 }
 ```
 
+
+
 ## Action outputs
 
 - `nowReading`: When a new book is started this output will contain an object with the book's: title, description, thumbnail, authors, and isbn.