Skip to content

Commit

Permalink
chore: clean up (#85)
Browse files Browse the repository at this point in the history
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
  • Loading branch information
pylapp committed Jan 20, 2025
1 parent d010ad9 commit 3505018
Showing 1 changed file with 0 additions and 36 deletions.
36 changes: 0 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,42 +54,6 @@ Guidelines for TV, Android, iOS and web environments will be merged in a "cohesi
The project is open source and topics like accessibility and ecodesign are also managed.
It should replace internal frameworks and also [ODS](https://github.com/Orange-OpenSource/ods-ios) in the near future.

## Import the library

Add in *Xcode* the Swift package dependency `https://github.com/Orange-OpenSource/ouds-ios`.

Then add in your project the modules you need within:
- `OUDSModules` containing OUDS modules with features
- `OUDSComponents` containing all components embeded also inside _modules_
- `OUDSThemesInverseTheme` providing a _theme_ with inverted colors for _components_
- `OUDSThemesOrangeTheme` providing the default _Orange_ theme defining style for _components_
- `OUDS` providing basic objects and low layer of responsabilities to help to implement _themes_
- `OUDSTokensComponent` providing _component tokens_ for _components_ to add in applications and _modules_
- `OUDSTokensSemantic` providing _semantic tokens_
- `OUDSTokensRaw` providing _raw tokens_
- `OUDSFoundations` providing low level and utils objects.

You must define the theme you use in your app root view:

```swift
import OUDS // To get OUDSThemeableView
import OUDSThemeOrange // To get OrangeTheme
import SwiftUI

@main
struct YourApp: App {
var body: some Scene {
WindowGroup {
OUDSThemeableView(theme: OrangeTheme()) {
// Your root view
}
}
}
}
```

Then get the current thme using `@Environment(\.theme) var theme` and use it! You can also use the moudles and the components exposed by the library.

## Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/Orange-OpenSource/ouds-ios/issues/new/choose).
Expand Down

0 comments on commit 3505018

Please sign in to comment.