Giter Club home page Giter Club logo

packagelist's Introduction

Valid JSON

The Swift Package Index

Anyone can add a package to the Swift Package Index. Every package indexed by the site comes from a list of package repository URLs, stored in a publicly available JSON file. To add a package to the index, add a URL to a package repository to that file.

Please feel free to submit your own, or other people's repositories to this list. There are a few requirements, but they aren't onerous.

The easiest way to validate that packages meet the requirements is to run the validation tool included in this repository. Fork this repository and clone your fork locally. Then edit packages.json and add the package URL(s) to the JSON. Finally, in the directory where you have the clone of your fork of this repository, run the following command:

swift ./validate.swift

When validation succeeds, commit your changes and submit your pull request! Your package(s) will appear in the index within a few minutes.


If you would prefer to validate the requirements manually, please verify that:

  • The package repositories are all publicly accessible.
  • The packages all contain a Package.swift file in the root folder.
  • The packages are written in Swift 5.0 or later.
  • The packages all contain at least one product (either library or executable), and at least one product must be usable in other Swift apps.
  • The packages all have at least one release tagged as a semantic version.
  • The packages all output valid JSON from swift package dump-package with the latest Swift toolchain.
  • The package URLs are all fully specified including the protocol (usually https) and the .git extension.
  • The packages all compile without errors.
  • The packages JSON file is sorted alphabetically.

Note: There's no gatekeeping or quality threshold to be included in the Swift Package Index. As long as packages are valid, and meet the requirements above, we will accept them.

packagelist's People

Contributors

adam-fowler avatar appracatappra avatar cs4alhaider avatar ctreffs avatar danielctull avatar daveverwer avatar diniska avatar dmartinsaiz avatar drewmccormack avatar eneko avatar finestructure avatar github-actions[bot] avatar gonzalezreal avatar hallee avatar helje5 avatar jdee avatar jessesquires avatar kiliankoe avatar leogdion avatar maxdesiatov avatar maxxfrazer avatar miguelangel-dev avatar mkj-is avatar nerdsupremacist avatar peter-schorn avatar phimage avatar rwbutler avatar sherlouk avatar sloik avatar zntfdr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.