From 6722732cf8db830ec28f2b92d87155f61b1424c7 Mon Sep 17 00:00:00 2001 From: "Kyle E. Mitchell" Date: Thu, 11 Apr 2019 23:31:32 -0700 Subject: [PATCH] docs: add package.json "sustainability" property --- doc/files/package.json.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/files/package.json.md b/doc/files/package.json.md index 95e77d34c5f9f..0272ba10e0bcd 100644 --- a/doc/files/package.json.md +++ b/doc/files/package.json.md @@ -170,6 +170,23 @@ Both email and url are optional either way. npm also sets a top-level "maintainers" field with your npm user info. +## sustainability + +You can specify an HTTP endpoint for up-to-date information about ways +to sustain development of your package so that people can learn more ways +to support your work: + + { "sustainability": "https://example.com/sustainability.json" } + +You may like to develop your sustainability file as a file in your +source repository: + + { "sustainability": "https://github.com/raw/{user}/{repo}/master/sustainability.json" } + +The end point you specify should respond to unauthenticated GET +requests with a JSON body that conforms to the [sustainability data +schema](https://www.npmjs.com/package/sustainability-schema). + ## files The optional `files` field is an array of file patterns that describes