funding-schema v2.1.0

funding-schema

JSON schema for open software project funding resources

Examples

{
  "project": "https://standardjs.com",
  "contributors": [
    {
      "name": "Feross Aboukhadijeh",
      "type": "person",
      "homepage": "https://feross.org",
      "links": [
        "https://www.patreon.com/feross",
        "https://feross.org/support/"
      ]
    }
  ]
}

{
  "project": "https://jquery.com",
  "contributors": [
    {
      "name": "JS Foundation",
      "type": "organization",
      "homepage": "https://js.foundation",
      "links": [
        "https://js.foundation/about/donate"
      ]
    }
  ]
}

{
  "project": "https://babeljs.io",
  "contributors": [
    {
      "name": "OpenCollective",
      "type": "organization",
      "homepage": "https://opencollective.com/babel",
      "links": [
        "https://opencollective.com/babel/contribute"
      ]
    }
  ]
}

{
  "project": "https://github.com/chalk/chalk",
  "contributors": [
    {
      "name": "Tidelift",
      "type": "organization",
      "homepage": "https://tidelift.com/",
      "links": [
        "https://tidelift.com/subscription/pkg/npm-chalk"
      ]
    }
  ]
}

{
  "project": "https://github.com/kemitchell/funding-schema.json",
  "contributors": [
    { "uri": "https://kemitchell.com/funding.json" }
  ]
}

API

This package exports a JSON schema for funding objects.

The definitions property of the schema contains all sub-schemas that you might like to load individually:

• project
• contributor
• contributorReference

This package treats the exposure of those sub-schemas as part of its public API for semantic versioning.

You can validate data against the schema using libraries like ajv.