diff --git a/.github/workflows/platformio-publish.yml b/.github/workflows/platformio-publish.yml
index fdf524069..12e2d5206 100644
--- a/.github/workflows/platformio-publish.yml
+++ b/.github/workflows/platformio-publish.yml
@@ -6,7 +6,7 @@ on:
- v*.*.*
jobs:
- build:
+ publish:
runs-on: ubuntu-latest
steps:
@@ -31,7 +31,7 @@ jobs:
python -m pip install --upgrade pip
pip install --upgrade platformio
- name: Publish PlatformIO package
- run: pio package publish
+ run: pio package publish --non-interactive
env:
CI: true
PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
diff --git a/README.md b/README.md
index 5b46ac0a1..5cc37e8cc 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,15 @@
# LibreTuya
+
+
+[![Discord](https://img.shields.io/discord/967863521511608370?color=%235865F2&label=Discord&logo=discord&logoColor=white)](https://discord.gg/SyGCB9Xwtf)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/kuba2k2/platform/libretuya.svg)](https://registry.platformio.org/platforms/kuba2k2/libretuya)
+![GitHub last commit](https://img.shields.io/github/last-commit/kuba2k2/libretuya)
+
+![RTL8710BN](https://img.shields.io/badge/-rtl8710bn-blue)
+
+
+
PlatformIO development platform for IoT modules manufactured by Tuya Inc.
The main goal of this project is to provide a usable build environment for IoT developers. While also providing vendor SDKs as PlatformIO cores,
@@ -10,6 +20,13 @@ LibreTuya also provides a common interface for all platform implementations. The
**Note:** this project is work-in-progress.
+## Usage
+
+1. [Install PlatformIO](https://platformio.org/platformio-ide)
+2. `platformio platform install libretuya`
+3. Create a project, build it and upload!
+4. See the [docs](docs/README.md) for any questions/problems.
+
## Board List
A (mostly) complete* list of Tuya wireless module boards.
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..77621ef73
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,3 @@
+# LibreTuya documentation
+
+TODO