From 5511d4bc6c86bdf44b44efcea4ef038293c40773 Mon Sep 17 00:00:00 2001 From: Robert Kieffer Date: Wed, 8 May 2024 14:36:12 -0700 Subject: [PATCH] docs: fix README typo, improve PackageJSON description (#40) 'noticed a typo, reworded description Otherwise the new release looks good to me. Note: It would probably behoove this project to have a clearer definition of what fields are / aren't defined in `PackageJSON`. package.json files are a mishmash of ad-hoc state, which makes for a bit of a slippery slope in terms of which types should / should not be defined here. But that's a problem for a future date. --------- Co-authored-by: Steven --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f9ea5c..2116010 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Response type for the `https://registry.npmjs.org/:packageName` endpoint, _when Response type for the `https://registry.npmjs.org/:packageName/:packageVersion` endpoint, _when made with the 'Accept: application/vnd.npm.install-v1+json' header_. Also the type of `Manifest['versions']` entries. ### PackageJSON -A "loose" definition of the "package.json" file type. +A "loose" definition of package.json structures. > [!NOTE] -> This is not an authoritative definition of package.json structures. It is merely a best-effort attempt to define the fields that may appear in `PackumentVersion` structures, are copied from a module's package.json file. +> This is not an authoritative definition of package.json structures. Rather, it is a best-effort attempt to describe the fields that are de-facto standards for Node.js, npm, and TypeScript development.