diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1fc5c62..8794182 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,13 +33,13 @@ jobs: - name: Set custom domain run: | mkdir -p site/ - echo docs.libretuya.ml > site/CNAME + echo docs.libretiny.eu > site/CNAME - name: Deploy docs - uses: libretuya/mkdocs-deploy-gh-pages@master + uses: libretiny-eu/mkdocs-deploy-gh-pages@master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} CONFIG_FILE: mkdocs.yml EXTRA_PACKAGES: build-base doxygen REQUIREMENTS: docs/requirements.txt - CUSTOM_DOMAIN: docs.libretuya.ml + CUSTOM_DOMAIN: docs.libretiny.eu diff --git a/README.md b/README.md index dd0fad6..6a8420b 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,42 @@
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/kuba2k2/libretuya/Deploy%20docs%20on%20GitHub%20Pages?label=docs&logo=markdown)](https://kuba2k2.github.io/libretuya/) -![GitHub last commit](https://img.shields.io/github/last-commit/kuba2k2/libretuya?logo=github) +[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/kuba2k2/libretiny/Deploy%20docs%20on%20GitHub%20Pages?label=docs&logo=markdown)](https://kuba2k2.github.io/libretiny/) +![GitHub last commit](https://img.shields.io/github/last-commit/kuba2k2/libretiny?logo=github) [![Code style: clang-format](https://img.shields.io/badge/code%20style-clang--format-purple.svg)](.clang-format) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![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) +[![PlatformIO Registry](https://badges.registry.platformio.org/packages/kuba2k2/platform/libretiny.svg)](https://registry.platformio.org/platforms/kuba2k2/libretiny) ![RTL8710BN](https://img.shields.io/badge/-rtl8710bn-blue) ![BK7231](https://img.shields.io/badge/-bk7231-blue)
+## LibreTuya is now LibreTiny! 🎉 + +We have [renamed the project](https://github.com/kuba2k2/libretiny/issues/92) to LibreTiny, also marking the very first v1.0.0 release, along with a huge structure refactor. While some care has been taken to ensure that things don't break, you may still need to update some references in your code to use the new name. + +--- + 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 project focuses on developing working Arduino-compatible cores for supported families. The cores are inspired by Espressif's official core for ESP32, which should make it easier to port/run existing ESP apps on less-common, unsupported IoT modules. -**There's an [ESPHome port](https://docs.libretuya.ml/docs/projects/esphome/) based on LibreTiny, which supports BK7231 and RTL8710B chips.** +**There's an [ESPHome port](https://docs.libretiny.eu/docs/projects/esphome/) based on LibreTiny, which supports BK7231 and RTL8710B chips.** **Note:** this project is work-in-progress. ## Usage 1. [Install PlatformIO](https://platformio.org/platformio-ide) -2. `platformio platform install -f https://github.com/kuba2k2/libretuya` +2. `platformio platform install -f https://github.com/kuba2k2/libretiny` 3. Create a project, build it and upload! -4. See the [docs](https://docs.libretuya.ml/) for any questions/problems. +4. See the [docs](https://docs.libretiny.eu/) for any questions/problems.