Skip to content

Commit

Permalink
[docs] Fix workflow, update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kuba2k2 committed Apr 29, 2022
1 parent 017224d commit b3fc6ea
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/platformio-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
- v*.*.*

jobs:
build:
publish:
runs-on: ubuntu-latest

steps:
Expand All @@ -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 }}
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# LibreTuya

<div align="center">

[![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)

</div>

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,
Expand All @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# LibreTuya documentation

TODO

0 comments on commit b3fc6ea

Please sign in to comment.