stanfordspezi/spezilicense

Overview

The Spezi License module provides a quick way to inform users about the tools and packages you have leveraged in your project including their license information. You use the `ContributionsList` abstraction within your views to visualize a list of all Swift package dependecies used in your Xcode project.

This package builds on Felix Hermann's' SwiftPackageList library under the hood.

Setup

1. Add Spezi License and Swift Package List as a Dependency.

You need to add the SpeziLicense and SwiftPackageList Swift package to your app in Xcode or Swift package.

2. Add the SwiftPackageListPlugin to your Xcode Project

Add the SwiftPackageListPlugin to the "Run Build Tool Plug-ins" in your Build Phases settings of your Xcode project as described in the SwiftPackageList documentation.

Example

Contributions List

The ContributionsList allows you to render a list containing all used Swift packages in your Xcode project including license infromation. The code example below showcases how to render a simple list view with all used package dependencies.

import SpeziLicense
import SwiftUI

struct ExamplePackageDependenciesView: View {

    var body: some View {
        ContributionsList(projectLicense: .mit)
    }
}

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first.

License

This project is licensed under the MIT License. See Licenses for more information.

[Spezi Footer] [Spezi Footer]

Package Metadata

Repository: stanfordspezi/spezilicense

Default branch: main

README: README.md