Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 2.81 KB

README.md

File metadata and controls

30 lines (21 loc) · 2.81 KB
Raw

Valid JSON

The Swift Package Index

Anyone can add a package to the Swift Package Index. Please feel free to submit any package repository to the index, whether it's a package written by you or someone else. There's also no quality threshold. As long as the packages are valid and meet the requirements below, we will accept them. If you're unsure about any of the requirements, please submit the package(s), and we'll happily provide help.

There are a few requirements for inclusion in the index, but they aren't onerous:

  • The package repositories must all be publicly accessible.
  • The packages must all contain a valid Package.swift file in the root folder.
  • The packages must be written in Swift 5.0 or later.
  • The packages should have at least one release tagged as a semantic version.
  • The packages must all output valid JSON when running swift package dump-package with the latest Swift toolchain.
  • The package URLs must include the protocol (usually https) and the .git extension.
  • The packages must all compile without errors.
  • All package content must comply with our code of conduct.

Add Packages Button

Note: Our build system can now generate and host DocC documentation and make it available from your package’s page in the index. All we need is a little configuration data so that we know how best to build your docs.

More information here.

Note: If submitting your own packages, don't forget to add shields.io badges to your package's README to always have up to date swift version and platform compatibility information readily available. Once your package appears in the index, use the "Do you maintain this package?" link in the right-hand sidebar of your package page and use the provided markdown.

For example:

Removing a Package

You can request to have a package removed from the index with this GitHub workflow.