diff --git a/README.md b/README.md index 1907272..216a601 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ Python SDK/CLI for Truffle devices. - schedule parsing: `truffile/truffile/schedule.py` - deploy planning + builder flow: `truffile/truffile/deploy/builder.py` - generated TruffleOS protos vendored in: `truffile/truffle/` -- examples: - - `truffile/example-apps/kalshi` - - `truffile/example-apps/reddit` +- app store examples: + - `truffile/app-store/kalshi` + - `truffile/app-store/reddit` `truffile.yaml` defines: - metadata (`name`, `description`, `type`) @@ -93,3 +93,14 @@ Refresh vendored protos from firmware repo: ```bash ./scripts/sync_protos.sh ``` + +## Contributors + +Contributors are welcome to submit apps to the Truffle App Store. + +To submit: +- open a PR with your app under the `app-store/` folder +- include a screen recording of your app in action + +The Truffle team will deploy accepted apps to the App Store for everyone with Truffle to use and your name will be featured there! +There may be small changes needed to make the app run optimally, but most features and the credit will remain yours. diff --git a/example-apps/kalshi/bg_worker.py b/app-store/kalshi/bg_worker.py similarity index 100% rename from example-apps/kalshi/bg_worker.py rename to app-store/kalshi/bg_worker.py diff --git a/example-apps/kalshi/client.py b/app-store/kalshi/client.py similarity index 100% rename from example-apps/kalshi/client.py rename to app-store/kalshi/client.py diff --git a/example-apps/kalshi/config.py b/app-store/kalshi/config.py similarity index 100% rename from example-apps/kalshi/config.py rename to app-store/kalshi/config.py diff --git a/example-apps/kalshi/icon.png b/app-store/kalshi/icon.png similarity index 100% rename from example-apps/kalshi/icon.png rename to app-store/kalshi/icon.png diff --git a/example-apps/kalshi/kalshi_background.py b/app-store/kalshi/kalshi_background.py similarity index 100% rename from example-apps/kalshi/kalshi_background.py rename to app-store/kalshi/kalshi_background.py diff --git a/example-apps/kalshi/kalshi_foreground.py b/app-store/kalshi/kalshi_foreground.py similarity index 100% rename from example-apps/kalshi/kalshi_foreground.py rename to app-store/kalshi/kalshi_foreground.py diff --git a/example-apps/kalshi/truffile.yaml b/app-store/kalshi/truffile.yaml similarity index 88% rename from example-apps/kalshi/truffile.yaml rename to app-store/kalshi/truffile.yaml index fb81377..0ba443a 100644 --- a/example-apps/kalshi/truffile.yaml +++ b/app-store/kalshi/truffile.yaml @@ -39,14 +39,6 @@ metadata: REPLACE_WITH_KALSHI_PRIVATE_KEY_PEM steps: - # - name: Welcome - # type: welcome - # content: | - # Welcome to Kalshi for Truffle. - - # This app lets your Truffle trade prediction markets, monitor - # positions, and get alerts on price changes and settlements. - - name: Install dependencies type: bash run: | diff --git a/example-apps/reddit/icon.png b/app-store/reddit/icon.png similarity index 100% rename from example-apps/reddit/icon.png rename to app-store/reddit/icon.png diff --git a/example-apps/reddit/old.png b/app-store/reddit/old.png similarity index 100% rename from example-apps/reddit/old.png rename to app-store/reddit/old.png diff --git a/example-apps/reddit/reddit.py b/app-store/reddit/reddit.py similarity index 100% rename from example-apps/reddit/reddit.py rename to app-store/reddit/reddit.py diff --git a/example-apps/reddit/truffile.yaml b/app-store/reddit/truffile.yaml similarity index 76% rename from example-apps/reddit/truffile.yaml rename to app-store/reddit/truffile.yaml index 1838adc..1a1116c 100644 --- a/example-apps/reddit/truffile.yaml +++ b/app-store/reddit/truffile.yaml @@ -24,12 +24,6 @@ metadata: daily_window: "00:00-23:59" icon_file: ./icon.png steps: - # - name: Reddit Setup - # type: welcome - # content: | - # The Reddit app will allow your Truffle to post relevant content from Reddit on your feed. - # You can customize which subreddits to follow in the configuration step. - # Please use this app in accordance with Reddit's terms of service. - name: Install dependencies type: bash run: |