From eabe952413784a9082b3f9a4b2c67e39056d8bcc Mon Sep 17 00:00:00 2001 From: Daniel LaCosse <3759828+daniellacosse@users.noreply.github.com> Date: Tue, 7 May 2024 10:58:19 -0400 Subject: [PATCH] committing to check image sizes --- README.md | 24 +++++++++++------------- client/README.md | 5 +---- src/electron/README.md | 4 ++-- 3 files changed, 14 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index b90509307e..0af41fc9b5 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,20 @@ -# Outline Apps +# Outline Manager Logo Outline Apps Outline Client Logo -[![Mattermost](https://badgen.net/badge/Mattermost/Outline%20Community/blue)](https://community.internetfreedomfestival.org/community/channels/outline-community) [![Reddit](https://badgen.net/badge/Reddit/r%2Foutlinevpn/orange)](https://www.reddit.com/r/outlinevpn/) -[![codecov](https://codecov.io/gh/Jigsaw-Code/outline-app/branch/master/graph/badge.svg?token=gasD8v5tjn)](https://codecov.io/gh/Jigsaw-Code/outline-app) +[![Reddit](https://badgen.net/badge/Reddit/r%2Foutlinevpn/orange)](https://www.reddit.com/r/outlinevpn/) [![Mattermost](https://badgen.net/badge/Mattermost/Outline%20Community/blue)](https://community.internetfreedomfestival.org/community/channels/outline-community) [![codecov](https://codecov.io/gh/Jigsaw-Code/outline-apps/branch/master/graph/badge.svg?token=gasD8v5tjn)](https://codecov.io/gh/Jigsaw-Code/outline-apps) -## Access to the free and open internet! +> [!NOTE] +> Test coverage currently only tracks the /client Apple Libraries and core web view code. -Outline makes it easy to create a VPN server, giving anyone access to the free and open internet. +Outline makes it easy for anyone to create a VPN server, allowing you to share access to the free and open internet with those in need. **We have two core applications:** -We have two core apps +Outline Manager Logo **Outline Manager** ([`/server_manager`](server_manager)): A graphical user interface for managing Outline servers. It is available for Windows, macOS, and Linux. [You can install the manager here](https://getoutline.org/get-started/#step-1). -- Outline Manager Logo **Outline Manager** ([`/server_manager`](server_manager)): A graphical user interface for managing Outline servers. It is available for Windows, macOS, and Linux. +Outline Client Logo **Outline Client** ([`/client`](client)): A cross-platform proxy client for Windows, macOS, iOS, Android, and Linux. The Outline Client is designed for use with the server deployed with the Outline Manager, but it is also fully compatible with any [Shadowsocks](https://shadowsocks.org/) server. [You can install the client here](https://getoutline.org/get-started/#step-3). -- Outline Client Logo **Outline Client** ([`/client`](client)): A cross-platform proxy client for Windows, macOS, iOS, Android, and Linux. The Outline Client is designed for use with the server deployed with the Outline Manager, but it is also fully compatible with any [Shadowsocks](https://shadowsocks.org/) server. +## Community and Support -Go to https://getoutline.org for ready-to-use versions of both. +Interested in contributing to Outline? See our [Contributing Guide](CONTRIBUTING.md) for more information. -**Join the Outline Community** by signing up for the [IFF Mattermost](https://wiki.digitalrights.community/index.php?title=IFF_Mattermost)! +You can also **join the Outline Community** by signing up for the [IFF Mattermost](https://wiki.digitalrights.community/index.php?title=IFF_Mattermost)! -## Support - -For support and to contact us, see: https://support.getoutline.org. +For customer support and to contact us directly, go to https://support.getoutline.org. diff --git a/client/README.md b/client/README.md index 3f9a344ad6..adb462c2b0 100644 --- a/client/README.md +++ b/client/README.md @@ -1,9 +1,6 @@ # Outline Client -![Build and Test](https://github.com/Jigsaw-Code/outline-apps/actions/workflows/build_and_test_debug_client.yml/badge.svg?branch=master) [![codecov](https://codecov.io/gh/Jigsaw-Code/outline-apps/graph/badge.svg?token=gasD8v5tjn)](https://codecov.io/gh/Jigsaw-Code/outline-apps) - -> [!NOTE] -> Test coverage currently only tracks the Apple Libraries and core web view code. +![Build and Test](https://github.com/Jigsaw-Code/outline-apps/actions/workflows/build_and_test_debug_client.yml/badge.svg?branch=master) The Outline Client is a cross-platform VPN or proxy client for Windows, macOS, iOS, Android, and ChromeOS. The Outline Client is designed for use with the [Outline Server](https://github.com/Jigsaw-Code/outline-server) software, but it is fully compatible with any [Shadowsocks](https://shadowsocks.org/) server. diff --git a/src/electron/README.md b/src/electron/README.md index d737bdfb95..46666da553 100644 --- a/src/electron/README.md +++ b/src/electron/README.md @@ -5,13 +5,13 @@ Unlike the Android and Apple clients, the Windows and Linux clients use the Elec To build the Electron clients, run (it will also package an installer executable into `build/dist`): ```sh -npm run action electron/build [windows|linux] +npm run action client/electron/build [windows|linux] ``` To run the Electron clients, run: ```sh -npm run action electron/start [windows|linux] +npm run action client/electron/start [windows|linux] ``` ## Cross-Compiling