Skip to content

Commit

Permalink
committing to check image sizes
Browse files Browse the repository at this point in the history
  • Loading branch information
daniellacosse committed May 7, 2024
1 parent 68bec81 commit eabe952
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 19 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# Outline Apps
# <img alt="Outline Manager Logo" src="docs/resources/logo_manager.png" title="Outline Manager" width="48"> Outline Apps <img alt="Outline Client Logo" src="docs/resources/logo_client.png" title="Outline Client" width="48">

[![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
<img alt="Outline Manager Logo" src="docs/resources/logo_manager.png" title="Outline Manager" width="25"> **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).

- <img alt="Outline Manager Logo" src="docs/resources/logo_manager.png" title="Outline Manager" width="25"> **Outline Manager** ([`/server_manager`](server_manager)): A graphical user interface for managing Outline servers. It is available for Windows, macOS, and Linux.
<img alt="Outline Client Logo" src="docs/resources/logo_client.png" title="Outline Client" width="25"> **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).

- <img alt="Outline Client Logo" src="docs/resources/logo_client.png" title="Outline Client" width="25"> **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.
5 changes: 1 addition & 4 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions src/electron/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit eabe952

Please sign in to comment.