Skip to content

Commit 6722732

Browse files
committed
docs: add package.json "sustainability" property
1 parent 656bce7 commit 6722732

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

doc/files/package.json.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,23 @@ Both email and url are optional either way.
170170

171171
npm also sets a top-level "maintainers" field with your npm user info.
172172

173+
## sustainability
174+
175+
You can specify an HTTP endpoint for up-to-date information about ways
176+
to sustain development of your package so that people can learn more ways
177+
to support your work:
178+
179+
{ "sustainability": "https://example.com/sustainability.json" }
180+
181+
You may like to develop your sustainability file as a file in your
182+
source repository:
183+
184+
{ "sustainability": "https://raw.githubusercontent.com/{user}/{repo}/master/sustainability.json" }
185+
186+
The end point you specify should respond to unauthenticated GET
187+
requests with a JSON body that conforms to the [sustainability data
188+
schema](https://www.npmjs.com/package/sustainability-schema).
189+
173190
## files
174191

175192
The optional `files` field is an array of file patterns that describes

0 commit comments

Comments
 (0)