diff --git a/README.md b/README.md index b9698ca6ef..d93373f35d 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,29 @@ ![Build and Test](https://github.com/Jigsaw-Code/outline-apps/actions/workflows/build_and_test_debug.yml/badge.svg?branch=master) [![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/) -> **Test coverage currently only tracks the Outline Client Apple Libraries and core web view code:** +> **Test coverage currently only tracks the Outline Client Apple Libraries and Web UI code:** > > [![codecov](https://codecov.io/gh/Jigsaw-Code/outline-apps/branch/master/graph/badge.svg?token=gasD8v5tjn)](https://codecov.io/gh/Jigsaw-Code/outline-apps) TODO: Write a project description -TODO: getting started (install the CLI) - ## Workspaces ### [Outline Client](outline_client/README.md) -TODO: Describe the Outline Client +The Outline Client is a cross-platform VPN or proxy client for Windows, macOS, iOS, Android, and Debian-based Linux distros. + +#### How to checkout only the Outline Client + +```sh +# TODO: have outline_apps manage this +git sparse-checkout set outline_client +``` -TODO: How to clone only the Client +#### How to run commands against the Outline Client ```sh -# example of what it will look like: -outline_apps clone outline_client +./outline_apps outline_client lint ``` ### [Outline Manager](outline_server/src/server_manager/README.md) @@ -31,7 +35,7 @@ Coming Soon! Coming Soon! -### [Outline SDK Examples: Access Key Tester](outline_sdk/access_key_tester/README.md) +### [Outline SDK Examples: Access Key Tester](outline_sdk_examples/access_key_tester/README.md) Coming Soon!