From 4ed2d45ad8914696358f4a1104dc6c6ac72ea1a4 Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Tue, 29 Jul 2025 22:11:32 +0400 Subject: [PATCH 1/2] doc: readme --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c335a4914..1dfa4d6d2 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,40 @@ # Open WebUI Desktop 🌐 + ![App Demo](./demo.png) -**Open WebUI App** is the cross-platform desktop application for [Open WebUI](https://github.com/open-webui/open-webui). It brings the _full-featured Open WebUI experience_ directly to your device, effectively transforming it into a powerful server—without the complexities of manual setup. + +**Open WebUI Desktop** is a cross-platform desktop application for [Open WebUI](https://github.com/open-webui/open-webui). It brings the _full-featured Open WebUI experience_ directly to your device, effectively transforming it into a powerful server—without the complexities of manual setup. This project is currently in **alpha** and under active development. 🛠️ Expect frequent updates and potential changes as we refine the application. ## Download 📥 -Get the latest alpha release from our [releases page](https://github.com/open-webui/desktop/releases). -**Note**: An internet connection is required for initial setup, but afterwards the application can be used completely offline. +> [!NOTE] +> An internet connection is required for initial setup, but afterwards the application can be used completely offline. + +Get the latest alpha release from our [releases page](https://github.com/open-webui/desktop/releases). ## Features + - **One-Click Installation**: Quickly and effortlessly install and set up Open WebUI with all its dependencies. This feature is fully functional and ready to make your setup a breeze. - **Cross-Platform Support**: Compatible with Windows, macOS, and Linux to ensure broad accessibility. - **Offline Capability**: After initial setup, use the application completely offline for enhanced privacy and reliability. ## Project Setup + ### Install + ```bash npm install ``` + ### Development + ```bash npm run dev ``` + ### Build + ```bash # For windows npm run build:win @@ -32,7 +43,11 @@ npm run build:mac # For Linux npm run build:linux ``` + ## License 📜 + This project is licensed under the **Open WebUI Sustainable Use License**. For details, see [LICENSE](LICENSE). + ## Stay Tuned! 🌟 -We're actively developing Open WebUI App. Follow [Open WebUI](https://github.com/open-webui/open-webui) for updates, and join the [community on Discord](https://discord.gg/5rJgQTnV4s) to stay involved. \ No newline at end of file + +We're actively developing Open WebUI. Follow [Open WebUI](https://github.com/open-webui/open-webui) for updates, and join the [community on Discord](https://discord.gg/5rJgQTnV4s) to stay involved. \ No newline at end of file From 9b05cb9a4d156500df047a680b3efc9137ad7ddb Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Tue, 29 Jul 2025 22:26:03 +0400 Subject: [PATCH 2/2] refac --- .github/workflows/build.yaml | 4 ++-- README.md | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 30f1690c2..7b5a239f8 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -13,8 +13,8 @@ jobs: strategy: matrix: include: - - os: ubuntu-latest - arch: x64 + # - os: ubuntu-latest + # arch: x64 # - os: ubuntu-latest # arch: arm64 - os: windows-latest diff --git a/README.md b/README.md index 1dfa4d6d2..40e6d5bfb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ **Open WebUI Desktop** is a cross-platform desktop application for [Open WebUI](https://github.com/open-webui/open-webui). It brings the _full-featured Open WebUI experience_ directly to your device, effectively transforming it into a powerful server—without the complexities of manual setup. -This project is currently in **alpha** and under active development. 🛠️ Expect frequent updates and potential changes as we refine the application. +> [!WARNING] +> This project is currently in **alpha** and under active development. 🛠️ Expect frequent updates and potential changes as we refine the application. ## Download 📥