Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #25

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Copyright (c) 2023 Proton Technologies AG

## Dependencies

This project uses Swift Package Manager for all of it's dependencies. Allow Xcode to resolve packages before running any target.
This project uses Swift Package Manager for all of its dependencies. Allow Xcode to resolve packages before running any target.

### Third-party dependencies

Expand All @@ -23,7 +23,7 @@ This project uses Swift Package Manager for all of it's dependencies. Allow Xcod

A set of secrets is required in order to build the project.
These include URLs and keys, and are kept in files named `ObfuscatedConstants.swift`.
These files are kept in a seperate repository, which requires some additional setup to keep synchronised.
These files are kept in a seperate repository, which requires some additional setup to keep synchronized.

Firstly, invoke the script located at `scripts/credentials.sh` with the `setup` command.
Provide the path where you wish the secrets repository to be cloned locally using the `-p` argument, and the url of the repository using the `-r` argument.
Expand All @@ -36,7 +36,7 @@ Then, to verify that setup has been successful:
./scripts/credentials.sh checkout
```

If setup correctly, obfuscated constants will be automatically synchronised during the Generate Obfuscated Constants build phase of each app.
If setup correctly, obfuscated constants will be automatically synchronized during the Generate Obfuscated Constants build phase of each app.

## Package Structure

Expand Down