update basic readme

.github/workflows/pull_request_checks.yml

@@ -82,47 +82,3 @@ jobs:
         run: |
           echo "This PR has the 'need test' label. Please remove it before merging."
           exit 1
-
-  translations:
-    name: '[WIP] Missing Translations Label'
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pull-requests: write
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Check resources/original_messages.json
-        id: changed-original-messages
-        uses: tj-actions/changed-files@v35
-        with:
-          files: resources/original_messages.json
-
-      - name: Collect src/www/messages Changes
-        if: steps.changed-original-messages.outputs.any_changed == 'true' 
-        id: changed-translated-messages
-        uses: tj-actions/changed-files@v35
-        with:
-          files: src/www/messages/*.json
-
-      - name: Check src/www/messages Changes
-        if: steps.changed-original-messages.outputs.any_changed == 'true'
-        id: not-every-translation-changed
-        run: |
-          TRANSLATIONS_COUNT="$(ls src/www/messages | wc -l | xargs)"
-          IFS=' ' read -r -a TRANSLATED_MESSAGES <<< "${{ steps.changed-translated-messages.outputs.all_changed_files }}"
-          TRANSLATED_MESSAGES_COUNT="${#TRANSLATED_MESSAGES[@]}"
-          if [ "${TRANSLATED_MESSAGES_COUNT}" != "${TRANSLATIONS_COUNT}" ]; then
-            echo "Translations are not atomic. Please update all translations in a single commit."
-            echo "Changed translations: ${TRANSLATED_MESSAGES_COUNT}"
-            echo "Expected translations: ${TRANSLATIONS_COUNT}"
-            echo "result=true" >> "${GITHUB_OUTPUT}"
-          fi
-
-      - name: Apply 'Missing Translations' Label
-        if: steps.not-every-translation-changed.outputs.result == 'true'
-        uses: actions-ecosystem/action-add-labels@v1
-        with:
-          labels: missing translations

README.md

@@ -1,3 +1,21 @@
 # Outline Apps
 
-TODO
+[![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/)
+
+## Access to the free and open internet!
+
+Outline makes it easy to create a VPN server, giving anyone access to the free and open internet.
+
+We have two core apps: [Ouline Manager](./server_manager) and [Ouline Client](./client).
+
+### Outline Manager
+
+The Outline Manager is a graphical user interface for managing Outline servers. It is available for Windows, macOS, and Linux.
+
+### Outline Client
+
+The Outline Client is 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.
+
+## Support
+
+For support and to contact us, see: https://support.getoutline.org.

client/README.md

@@ -1,6 +1,6 @@
 # Outline Client
 
-![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/)
+![Build and Test](https://github.com/Jigsaw-Code/outline-apps/actions/workflows/build_and_test_debug_client.yml/badge.svg?branch=master)
 
 > **Test coverage currently only tracks the Apple Libraries and core web view code:**
 >
@@ -29,19 +29,17 @@ npm install
 Outline clients share the same web app across all platforms. This code is located in the src/www directory. If you are making changes to the shared web app and do not need to test platform-specific functionality, you can test in a desktop browser by running:
 
 ```sh
-npm run action src/www/start
+npm run action client/src/www/start
 ```
 
 The latter command will open a browser instance running the app. Browser platform development will use fake servers to test successful and unsuccessful connections.
 
 The app logic is located in [src/www/app](src/www/app). UI components are located in [src/www/ui_components](src/www/ui_components). If you want to work specifically on an individual UI element, try the storybook!:
 
 ```sh
-npm run action src/www/storybook
+npm run action client/src/www/storybook
 ```
 
-> 💡 NOTE: the `src` part of the path is optional. `npm run action www/start` resolves to the same script.
-
 > 💡 NOTE: every script in this repository can be run with `npm run action` -
 > for a CLI-like experience, add something like
 >
@@ -58,7 +56,7 @@ npm run action src/www/storybook
 Certain actions take configuration flags - but since we're running them through `npm`, you'll have to use the `--` seperator to funnel them through to the underlying process. For example, to set up a MacOS project in release mode, you'd run:
 
 ```sh
-SENTRY_DSN=<your sentry dsn> npm run action cordova/setup macos -- --buildMode=release --versionName=<your version name>
+SENTRY_DSN=<your sentry dsn> npm run action client/src/cordova/setup macos -- --buildMode=release --versionName=<your version name>
 ```
 
 ## Life of a Packet
@@ -87,7 +85,3 @@ export SENTRY_DSN=[Sentry development API key]
 ```
 
 Release builds on CI are configured with a production Sentry API key.
-
-## Support
-
-For support and to contact us, see: https://support.getoutline.org.