Skip to content

Commit

Permalink
instruction updates
Browse files Browse the repository at this point in the history
  • Loading branch information
daniellacosse committed Aug 10, 2023
1 parent 72f736c commit 8b3108b
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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!

Expand Down

0 comments on commit 8b3108b

Please sign in to comment.