From 34f1e64639f449b023e0da518a8c70716c6b5f64 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Lapersonne Date: Tue, 16 Jul 2024 17:09:30 +0200 Subject: [PATCH] chore: create basic architecture for OUDS Swift Package (#46) (#48) Closes #46 Signed-off-by: Pierre-Yves Lapersonne --- .gitignore | 8 ++++---- README.md | 11 +++++++++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index a83bc6026c..2865c2e3cb 100644 --- a/.gitignore +++ b/.gitignore @@ -20,12 +20,12 @@ /Brewfile.lock.json # Produced by CocoaPods -OUDS/Pods/ +Showcase/Pods/ # Produced by Xcode -OUDS/Showcase.xcodeproj/xcuserdata/ -OUDS/Showcase.xcworkspace/xcuserdata/ -OUDS/DerivedData/ +Showcase/Showcase.xcodeproj/xcuserdata/ +Showcase/Showcase.xcworkspace/xcuserdata/ +DerivedData/ # Produced by Swift Package Manager .swiftpm/xcode/xcuserdata/ diff --git a/README.md b/README.md index 2e2315530d..1279940e64 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,17 @@ This repository contains the OUDS iOS library that provides Orange iOS components, but also a demo application showcasing these different components. +## Integrate OUDS + +If you want to add the iOS library of `Orange Unified Design System`, you need to add our _Swift Package_ into your project. +To do that, add a new _package dependency_ to your _Xcode_ project by refering to it with `https://github.com/Orange-OpenSource/ouds-ios`. +You are free to choose wether or not you want a branch or a specific tag. +Then you will be able to import the library and the product you want jsut with a simple import in your Swift files like: + +```swift +import OUDS +``` + ## 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).