Add readme

winglang · Nov 15, 2023 · ce0ec56 · ce0ec56
1 parent 415fbdb
commit ce0ec56
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/examples/feedreader/Readme.md b/examples/feedreader/Readme.md
@@ -1,2 +1,16 @@
-// bucket supports onInsert, while Table does not
-// see https://github.com/winglang/wing/issues/2841
+# Feedreader
+
+This is an example of a WingLang project that demonstrates the usage of cloud services to read a Github Atom feed and trigger a Github Action when a new version is detected.
+
+## Usage
+
+1. Set up a new cloud secret with the name "github-token" and your Github token as the value.
+2. Deploy the project.
+3. The program will run every hour, checking the Github Atom feed for new versions.
+4. If a new version is detected, it will trigger the specified Github Action and store a record in a cloud bucket.
+5. Add `workflow_dispatch:` to the Github Action you want to trigger. This allows the action to be run manually from the Github Actions UI or API.
+
+![console](./console.png)
+
+![workflow](./workflow.png)
+
diff --git a/examples/feedreader/console.png b/examples/feedreader/console.png
diff --git a/examples/feedreader/workflow.png b/examples/feedreader/workflow.png