[docs] Fix workflow, update README.md
Some checks failed
PlatformIO Publish / publish (push) Has been cancelled
Some checks failed
PlatformIO Publish / publish (push) Has been cancelled
This commit is contained in:
4
.github/workflows/platformio-publish.yml
vendored
4
.github/workflows/platformio-publish.yml
vendored
@@ -6,7 +6,7 @@ on:
|
|||||||
- v*.*.*
|
- v*.*.*
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
publish:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
@@ -31,7 +31,7 @@ jobs:
|
|||||||
python -m pip install --upgrade pip
|
python -m pip install --upgrade pip
|
||||||
pip install --upgrade platformio
|
pip install --upgrade platformio
|
||||||
- name: Publish PlatformIO package
|
- name: Publish PlatformIO package
|
||||||
run: pio package publish
|
run: pio package publish --non-interactive
|
||||||
env:
|
env:
|
||||||
CI: true
|
CI: true
|
||||||
PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
|
PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
|
||||||
|
|||||||
17
README.md
17
README.md
@@ -1,5 +1,15 @@
|
|||||||
# LibreTuya
|
# LibreTuya
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
[](https://discord.gg/SyGCB9Xwtf)
|
||||||
|
[](https://registry.platformio.org/platforms/kuba2k2/libretuya)
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
PlatformIO development platform for IoT modules manufactured by Tuya Inc.
|
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,
|
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.
|
**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
|
## Board List
|
||||||
|
|
||||||
A (mostly) complete* list of Tuya wireless module boards.
|
A (mostly) complete* list of Tuya wireless module boards.
|
||||||
|
|||||||
3
docs/README.md
Normal file
3
docs/README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# LibreTuya documentation
|
||||||
|
|
||||||
|
TODO
|
||||||
Reference in New Issue
Block a user