Skip to content

Commit 1f13229

Browse files
0xLeifgoogle-labs-jules[bot]Copilotgemini-code-assist[bot]
authored
Translate docs (#138)
* Translate README and documentation into 7 languages * Translate README and documentation into 7 languages This change translates the README.md file and all of the files in the `/documentation` directory into German (de), Spanish (es), French (fr), Hindi (hi), Portuguese (pt), Russian (ru), and Simplified Chinese (zh-CN). It creates new files for each translation, such as `README.de.md` for the German translation of the README, and places the translated documentation files in new language-specific subdirectories within the `/documentation` directory (e.g., `/documentation/de/`). It also moves the localized READMEs to the `documentation` folder and updates the main README to link to them. * feat: Add comprehensive documentation translations This commit introduces a significant internationalization update by translating the project's README and the entire contents of the /documentation directory into seven additional languages: - German (de) - Spanish (es) - French (fr) - Hindi (hi) - Portuguese (pt) - Russian (ru) - Simplified Chinese (zh-CN) To better support this multilingual structure, the original English documentation has been moved from the root of the /documentation directory into a new `en/` subdirectory. All internal markdown links have been carefully updated across all files to ensure they point to the correct relative paths for the new localized directory structure. This includes updating the main README to link to the translated READMEs and ensuring all cross-references within the documentation files work correctly for each language. * Fix translations and add disclaimer to docs (#139) * Fix translations and add disclaimer to docs * Fix translations and add disclaimer to docs --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> * Add SyncState documentation and update links (#140) * Add SyncState documentation and update links * Update documentation/es/starting-to-use-syncstate.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update documentation/fr/starting-to-use-syncstate.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update documentation/de/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/en/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/en/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/fr/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/hi/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/pt/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update documentation/ru/starting-to-use-syncstate.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * This commit addresses the task of reviewing and improving the machine… (#141) * This commit addresses the task of reviewing and improving the machine-translated documentation in the repository. As a professional translator, I systematically reviewed the documentation for the following languages: Spanish (es), German (de), French (fr), Hindi (hi), Portuguese (pt), Russian (ru), and Chinese (zh-CN). The following changes were made across all reviewed languages: - **Correction of Errors**: Fixed typos, grammatical mistakes, and awkward phrasing to enhance readability and professional tone. - **Disclaimer Standardization**: Replaced the existing machine-translation disclaimer with a consistent and more professional version across all translated files. - **Formatting Fixes**: Addressed minor formatting issues, such as adding missing titles to some documents to improve structure. The review was conducted on a file-by-file basis for each language, comparing the translation with the original English source to ensure accuracy and fluency. The review for all languages except Chinese is complete. The review for the Chinese (zh-CN) documentation is nearly complete, with 15 out of 17 files reviewed and corrected. * Update migration-considerations.md --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent 2a2a8f9 commit 1f13229

File tree

144 files changed

+12633
-19
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+12633
-19
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[![License](https://img.shields.io/github/license/0xLeif/AppState)](https://github.com/0xLeif/AppState/blob/main/LICENSE)
77
[![Version](https://img.shields.io/github/v/release/0xLeif/AppState)](https://github.com/0xLeif/AppState/releases)
88

9+
Read this in other languages: [French](documentation/README.fr.md) | [German](documentation/README.de.md) | [Hindi](documentation/README.hi.md) | [Portuguese](documentation/README.pt.md) | [Russian](documentation/README.ru.md) | [Simplified Chinese](documentation/README.zh-CN.md) | [Spanish](documentation/README.es.md)
10+
911
**AppState** is a Swift 6 library designed to simplify the management of application state in a thread-safe, type-safe, and SwiftUI-friendly way. It provides a set of tools to centralize and synchronize state across your application, as well as inject dependencies into various parts of your app.
1012

1113
## Requirements
@@ -38,9 +40,9 @@
3840

3941
## Getting Started
4042

41-
To integrate **AppState** into your Swift project, you’ll need to use the Swift Package Manager. Follow the [Installation Guide](documentation/installation.md) for detailed instructions on setting up **AppState**.
43+
To integrate **AppState** into your Swift project, you’ll need to use the Swift Package Manager. Follow the [Installation Guide](documentation/en/installation.md) for detailed instructions on setting up **AppState**.
4244

43-
After installation, refer to the [Usage Overview](documentation/usage-overview.md) for a quick introduction on how to manage state and inject dependencies into your project.
45+
After installation, refer to the [Usage Overview](documentation/en/usage-overview.md) for a quick introduction on how to manage state and inject dependencies into your project.
4446

4547
## Quick Example
4648

@@ -74,28 +76,28 @@ This snippet demonstrates defining a state value in an `Application` extension a
7476

7577
Here’s a detailed breakdown of **AppState**'s documentation:
7678

77-
- [Installation Guide](documentation/installation.md): How to add **AppState** to your project using Swift Package Manager.
78-
- [Usage Overview](documentation/usage-overview.md): An overview of key features with example implementations.
79+
- [Installation Guide](documentation/en/installation.md): How to add **AppState** to your project using Swift Package Manager.
80+
- [Usage Overview](documentation/en/usage-overview.md): An overview of key features with example implementations.
7981

8082
### Detailed Usage Guides:
8183

82-
- [State and Dependency Management](documentation/usage-state-dependency.md): Centralize state and inject dependencies throughout your app.
83-
- [Slicing State](documentation/usage-slice.md): Access and modify specific parts of the state.
84-
- [StoredState Usage Guide](documentation/usage-storedstate.md): How to persist lightweight data using `StoredState`.
85-
- [FileState Usage Guide](documentation/usage-filestate.md): Learn how to persist larger amounts of data securely on disk.
86-
- [Keychain SecureState Usage](documentation/usage-securestate.md): Store sensitive data securely using the Keychain.
87-
- [iCloud Syncing with SyncState](documentation/usage-syncstate.md): Keep state synchronized across devices using iCloud.
88-
- [FAQ](documentation/faq.md): Answers to common questions when using **AppState**.
89-
- [Constant Usage Guide](documentation/usage-constant.md): Access read-only values from your state.
90-
- [ObservedDependency Usage Guide](documentation/usage-observeddependency.md): Work with `ObservableObject` dependencies in your views.
91-
- [Advanced Usage](documentation/advanced-usage.md): Techniques like just‑in‑time creation and preloading dependencies.
92-
- [Best Practices](documentation/best-practices.md): Tips for structuring your app’s state effectively.
93-
- [Migration Considerations](documentation/migration-considerations.md): Guidance when updating persisted models.
84+
- [State and Dependency Management](documentation/en/usage-state-dependency.md): Centralize state and inject dependencies throughout your app.
85+
- [Slicing State](documentation/en/usage-slice.md): Access and modify specific parts of the state.
86+
- [StoredState Usage Guide](documentation/en/usage-storedstate.md): How to persist lightweight data using `StoredState`.
87+
- [FileState Usage Guide](documentation/en/usage-filestate.md): Learn how to persist larger amounts of data securely on disk.
88+
- [Keychain SecureState Usage](documentation/en/usage-securestate.md): Store sensitive data securely using the Keychain.
89+
- [iCloud Syncing with SyncState](documentation/en/usage-syncstate.md): Keep state synchronized across devices using iCloud.
90+
- [FAQ](documentation/en/faq.md): Answers to common questions when using **AppState**.
91+
- [Constant Usage Guide](documentation/en/usage-constant.md): Access read-only values from your state.
92+
- [ObservedDependency Usage Guide](documentation/en/usage-observeddependency.md): Work with `ObservableObject` dependencies in your views.
93+
- [Advanced Usage](documentation/en/advanced-usage.md): Techniques like just‑in‑time creation and preloading dependencies.
94+
- [Best Practices](documentation/en/best-practices.md): Tips for structuring your app’s state effectively.
95+
- [Migration Considerations](documentation/en/migration-considerations.md): Guidance when updating persisted models.
9496

9597
## Contributing
9698

97-
We welcome contributions! Please check out our [Contributing Guide](documentation/contributing.md) for how to get involved.
99+
We welcome contributions! Please check out our [Contributing Guide](documentation/en/contributing.md) for how to get involved.
98100

99101
## Next Steps
100102

101-
With **AppState** installed, you can start exploring its key features by checking out the [Usage Overview](documentation/usage-overview.md) and more detailed guides. Get started with managing state and dependencies effectively in your Swift projects! For more advanced usage techniques, like Just-In-Time creation and preloading dependencies, see the [Advanced Usage Guide](documentation/advanced-usage.md). You can also review the [Constant](documentation/usage-constant.md) and [ObservedDependency](documentation/usage-observeddependency.md) guides for additional features.
103+
With **AppState** installed, you can start exploring its key features by checking out the [Usage Overview](documentation/en/usage-overview.md) and more detailed guides. Get started with managing state and dependencies effectively in your Swift projects! For more advanced usage techniques, like Just-In-Time creation and preloading dependencies, see the [Advanced Usage Guide](documentation/en/advanced-usage.md). You can also review the [Constant](documentation/en/usage-constant.md) and [ObservedDependency](documentation/en/usage-observeddependency.md) guides for additional features.

documentation/README.de.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# AppState
2+
3+
[![macOS Build](https://img.shields.io/github/actions/workflow/status/0xLeif/AppState/macOS.yml?label=macOS&branch=main)](https://github.com/0xLeif/AppState/actions/workflows/macOS.yml)
4+
[![Ubuntu Build](https://img.shields.io/github/actions/workflow/status/0xLeif/AppState/ubuntu.yml?label=Ubuntu&branch=main)](https://github.com/0xLeif/AppState/actions/workflows/ubuntu.yml)
5+
[![Windows Build](https://img.shields.io/github/actions/workflow/status/0xLeif/AppState/windows.yml?label=Windows&branch=main)](https://github.com/0xLeif/AppState/actions/workflows/windows.yml)
6+
[![License](https://img.shields.io/github/license/0xLeif/AppState)](https://github.com/0xLeif/AppState/blob/main/LICENSE)
7+
[![Version](https://img.shields.io/github/v/release/0xLeif/AppState)](https://github.com/0xLeif/AppState/releases)
8+
9+
**AppState** ist eine Swift 6-Bibliothek, die entwickelt wurde, um die Verwaltung des Anwendungszustands auf eine threadsichere, typsichere und SwiftUI-freundliche Weise zu vereinfachen. Sie bietet eine Reihe von Werkzeugen, um den Zustand in Ihrer gesamten Anwendung zu zentralisieren und zu synchronisieren sowie Abhängigkeiten in verschiedene Teile Ihrer App zu injizieren.
10+
11+
## Anforderungen
12+
13+
- **iOS**: 15.0+
14+
- **watchOS**: 8.0+
15+
- **macOS**: 11.0+
16+
- **tvOS**: 15.0+
17+
- **visionOS**: 1.0+
18+
- **Swift**: 6.0+
19+
- **Xcode**: 16.0+
20+
21+
**Unterstützung für Nicht-Apple-Plattformen**: Linux & Windows
22+
23+
> 🍎 Mit diesem Symbol gekennzeichnete Funktionen sind spezifisch für Apple-Plattformen, da sie auf Apple-Technologien wie iCloud und dem Schlüsselbund basieren.
24+
25+
## Hauptmerkmale
26+
27+
**AppState** enthält mehrere leistungsstarke Funktionen zur Verwaltung von Zustand und Abhängigkeiten:
28+
29+
- **State**: Zentralisierte Zustandsverwaltung, die es Ihnen ermöglicht, Änderungen in der gesamten App zu kapseln und zu übertragen.
30+
- **StoredState**: Persistenter Zustand mit `UserDefaults`, ideal zum Speichern kleiner Datenmengen zwischen App-Starts.
31+
- **FileState**: Persistenter Zustand, der mit `FileManager` gespeichert wird und nützlich ist, um größere Datenmengen sicher auf der Festplatte zu speichern.
32+
- 🍎 **SyncState**: Synchronisieren Sie den Zustand über mehrere Geräte mit iCloud und stellen Sie die Konsistenz der Benutzereinstellungen sicher.
33+
- 🍎 **SecureState**: Speichern Sie sensible Daten sicher mit dem Schlüsselbund und schützen Sie Benutzerinformationen wie Token oder Passwörter.
34+
- **Abhängigkeitsmanagement**: Injizieren Sie Abhängigkeiten wie Netzwerkdienste oder Datenbankclients in Ihre gesamte App für eine bessere Modularität und Testbarkeit.
35+
- **Slicing**: Greifen Sie auf bestimmte Teile eines Zustands oder einer Abhängigkeit zu, um eine granulare Kontrolle zu erhalten, ohne den gesamten Anwendungszustand verwalten zu müssen.
36+
- **Constants**: Greifen Sie auf schreibgeschützte Teile Ihres Zustands zu, wenn Sie unveränderliche Werte benötigen.
37+
- **Observed Dependencies**: Beobachten Sie `ObservableObject`-Abhängigkeiten, damit Ihre Ansichten aktualisiert werden, wenn sie sich ändern.
38+
39+
## Erste Schritte
40+
41+
Um **AppState** in Ihr Swift-Projekt zu integrieren, müssen Sie den Swift Package Manager verwenden. Befolgen Sie die [Installationsanleitung](de/installation.md) für detaillierte Anweisungen zur Einrichtung von **AppState**.
42+
43+
Nach der Installation finden Sie in der [Verwendungsübersicht](de/usage-overview.md) eine kurze Einführung in die Verwaltung des Zustands und die Injektion von Abhängigkeiten in Ihr Projekt.
44+
45+
## Schnelles Beispiel
46+
47+
Unten sehen Sie ein minimales Beispiel, das zeigt, wie man einen Zustandsausschnitt definiert und von einer SwiftUI-Ansicht darauf zugreift:
48+
49+
```swift
50+
import AppState
51+
import SwiftUI
52+
53+
private extension Application {
54+
var counter: State<Int> {
55+
state(initial: 0)
56+
}
57+
}
58+
59+
struct ContentView: View {
60+
@AppState(\.counter) var counter: Int
61+
62+
var body: some View {
63+
VStack {
64+
Text("Zähler: \(counter)")
65+
Button("Inkrementieren") { counter += 1 }
66+
}
67+
}
68+
}
69+
```
70+
71+
Dieser Ausschnitt zeigt, wie man einen Zustandswert in einer `Application`-Erweiterung definiert und den `@AppState`-Property-Wrapper verwendet, um ihn in einer Ansicht zu binden.
72+
73+
## Dokumentation
74+
75+
Hier ist eine detaillierte Aufschlüsselung der Dokumentation von **AppState**:
76+
77+
- [Installationsanleitung](de/installation.md): So fügen Sie **AppState** mit dem Swift Package Manager zu Ihrem Projekt hinzu.
78+
- [Verwendungsübersicht](de/usage-overview.md): Eine Übersicht über die wichtigsten Funktionen mit Beispielimplementierungen.
79+
80+
### Detaillierte Verwendungsanleitungen:
81+
82+
- [Zustands- und Abhängigkeitsmanagement](de/usage-state-dependency.md): Zentralisieren Sie den Zustand und injizieren Sie Abhängigkeiten in Ihrer gesamten App.
83+
- [Zustand slicen](de/usage-slice.md): Greifen Sie auf bestimmte Teile des Zustands zu und ändern Sie sie.
84+
- [StoredState-Verwendungsanleitung](de/usage-storedstate.md): So persistieren Sie leichtgewichtige Daten mit `StoredState`.
85+
- [FileState-Verwendungsanleitung](de/usage-filestate.md): Erfahren Sie, wie Sie größere Datenmengen sicher auf der Festplatte persistieren.
86+
- [SecureState mit Schlüsselbund verwenden](de/usage-securestate.md): Speichern Sie sensible Daten sicher mit dem Schlüsselbund.
87+
- [iCloud-Synchronisierung mit SyncState](de/usage-syncstate.md): Halten Sie den Zustand über Geräte hinweg mit iCloud synchron.
88+
- [FAQ](de/faq.md): Antworten auf häufig gestellte Fragen zur Verwendung von **AppState**.
89+
- [Konstanten-Verwendungsanleitung](de/usage-constant.md): Greifen Sie auf schreibgeschützte Werte aus Ihrem Zustand zu.
90+
- [ObservedDependency-Verwendungsanleitung](de/usage-observeddependency.md): Arbeiten Sie mit `ObservableObject`-Abhängigkeiten in Ihren Ansichten.
91+
- [Erweiterte Verwendung](de/advanced-usage.md): Techniken wie Just-in-Time-Erstellung und Vorabladen von Abhängigkeiten.
92+
- [Beste Praktiken](de/best-practices.md): Tipps zur effektiven Strukturierung des Zustands Ihrer App.
93+
- [Überlegungen zur Migration](de/migration-considerations.md): Anleitung zur Aktualisierung persistierter Modelle.
94+
95+
## Mitwirken
96+
97+
Wir freuen uns über Beiträge! Bitte lesen Sie unsere [Anleitung für Mitwirkende](de/contributing.md), um zu erfahren, wie Sie sich beteiligen können.
98+
99+
## Nächste Schritte
100+
101+
Nach der Installation von **AppState** können Sie die wichtigsten Funktionen erkunden, indem Sie sich die [Verwendungsübersicht](de/usage-overview.md) und detailliertere Anleitungen ansehen. Beginnen Sie mit der effektiven Verwaltung von Zustand und Abhängigkeiten in Ihren Swift-Projekten! Für fortgeschrittenere Verwendungstechniken wie die Just-In-Time-Erstellung und das Vorabladen von Abhängigkeiten siehe die [Anleitung zur erweiterten Verwendung](de/advanced-usage.md). Sie können auch die Anleitungen zu [Konstanten](de/usage-constant.md) und [ObservedDependency](de/usage-observeddependency.md) für zusätzliche Funktionen einsehen.
102+
103+
---
104+
Diese Übersetzung wurde automatisch generiert und kann Fehler enthalten. Wenn Sie Muttersprachler sind, freuen wir uns über Ihre Korrekturvorschläge per Pull Request.

0 commit comments

Comments
 (0)