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

README updates #36

Merged
merged 3 commits into from
Feb 11, 2025
Merged

README updates #36

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bce1a54
Add further notes section in README
stelabouras Jan 16, 2025
6784e87
Add note under minimum requirements
stelabouras Feb 5, 2025
fb57124
Update pulling section
stelabouras Feb 11, 2025
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
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,16 @@ when the SDK populates its cache during its initialization.

The only variation related limitation concerns the width variants [^1] [^2].

##### Further notes

* In order for the `push` command to be successful, the target project / workspace
must be buildable by Xcode with no compilation errors.

* If you are trying to `push` the translations of a CocoaPods project, then use
the `.xcworkspace` directory on the `--project` argument instead of the
`.xcodeproj` one, otherwise the `push` command will fail with framework not found
linker errors.

#### Pulling

`txios-cli pull --token <transifex_token> --translated-locales <translated_locale_list> --output <output_directory>`
Expand All @@ -161,6 +171,16 @@ command can be simplified to:

`txios-cli pull --translated-locales <translated_locale_list> --output <output_directory>`

After successfully pulling the `txstrings.json` file to a specified output directory,
you can bundle it in your Xcode project by copying it and making sure it is included in
the 'Copy Bundle Resources' build phase, so that Transifex Native library can
look it up upon your application's launch.

Bundling this file to your project means that the SDK will be able to locate and use those
cached translations immediately upon launch, even when the device is offline, without the need
for the app to download the translations over the Internet and display them on the next
application launch.

#### Invalidating CDS cache

`txios-cli invalidate --token <transifex_token>`
Expand All @@ -179,6 +199,18 @@ command can be simplified to:
|-----------------|-----------------|--------------|
| Swift 5.3 | Xcode 15.4 | MacOS 10.13 |

> [!NOTE]
>
> Please make sure that the active developer directory points to the Xcode directory.
>
> To print the active developer directory path: `xcode-select -p`
>
> To switch the active developer directory path to Xcode:
>
> ```
> xcode-select -s /Applications/Xcode.app/Contents/Developer
> ```

## License

Licensed under Apache License 2.0, see [LICENSE](LICENSE) file.
Expand Down