SwiftLib

Statut du projet 🚧

Ce projet est actuellement en cours de construction.

Toute contribution est la bienvenue !

Description 📖

Contient les extensions Swift couramment utilisées chez Niji.

Installation ⚙️

Swift Package Manager

Vous pouvez utiliser Swift Package Manager pour installer SwiftLib en ajoutant la description suivante à votre fichier Package.swift :

import PackageDescription

let package = Package(
    name: "YOUR_PROJECT_NAME",
    targets: [],
    dependencies: [
        .package(url: "https://github.com/NijiDigital/SwiftLib", from: "1.0.0")
    ]
)

Ensuite, ajoutez SwiftLib à vos targets dependencies :

.target(
    name: "YOUR_TARGET_NAME",
    dependencies: [
        "SwiftLib",
    ]
),

Puis lancez la commande swift package update.

CocoaPods

Pour intégrer SwiftLib à votre projet Xcode en utilisant CocoaPods, renseignez le dans votre Podfile :

pod 'SwiftLib'

Puis lancez la commande pod install.

Manuellement

Ajoutez le dossier SwiftLib à votre projet Xcode pour utiliser les extensions.

Utilisation 🚀

Importez la librairie dans le fichier dans lequel vous voulez avoir accès aux extensions avec

import SwiftLib

...

Puis utilisez les extensions comme vous le feriez normalement si vous les aviez écrites dans votre fichier courrant.

Roadmap 📆

• Peupler la librairie des extensions utiles.
• Documenter et lister les extensions.

Comment contribuer 🔨

Tout le monde est invité à contribuer à ce projet en y ajoutant les extensions qui vous paraissent utiles et que vous verriez être utilisées dans d'autres projets chez Niji.

Les contributions se font sur le principe de MR et doivent être approuvées par un pair avant d'être mergées.
Il n'y a donc pas besoin de fork le projet, vous devriez avoir les droits dessus. Si ce n'est pas le cas, merci de vous tourner vers un admin du projet pour qu'il vous les donne.

Pour tester les modifications de la librairie en direct, remplacez la ligne pod 'SwiftLib' du Podfile de votre projet de test par :

pod 'SwiftLib', :path => '/Users/yourusername/path/to/pod/repo/SwiftLib'

Puis lancez la commande pod install.

Vous pourrez alors tester les modifications directement sans avoir besoin de push un nouveau tag.

Auteurs et contributeurs 🖋

Un grand merci aux contributeurs du projet ! ❤️

Liste des contributeurs :

• Mathieu VIEL
• Nicolas RENAUD

Licence 📝

SwiftLib est soumis à la licence MIT. Voir la licence pour plus d'informations.