docs: clarify package name rules (#1326)
- Add missing information as per Issue #1295 - use secure hyperText Transfer Protocol : https --------- Co-authored-by: Gar <wraithgar@github.com>
Sarkis Kovlekjian committed
Oct 14, 2024 at 20:44 UTC
6cd32d84f3cb79acc71a897b898945c34c88ae59
1 file changed
+4
-4
content/packages-and-modules/contributing-packages-to-the-registry/creating-a-package-json-file.mdx
+4
-4
@@ -25,16 +25,16 @@ A `package.json` file:
25
26
A `package.json` file must contain `"name"` and `"version"` fields.
27
28
-The `"name"` field contains your package's name, and must be lowercase and one word, and may contain hyphens and underscores.
28
+The `"name"` field contains your package's name and *must* be lowercase *without* any spaces. May contain _hyphens_, _dots_, and _underscores_.
29
30
The `"version"` field must be in the form `x.x.x` and follow the [semantic versioning guidelines][semver].
31
32
### Author field
33
34
-If you want to include package author information in `"author"` field, use the following format (email and website are both optional):
34
+If you want inclusive package author information, in the `"author"` field use the following format (email and website are both optional):
35
36
```
37
-Your Name <email@example.com> (http://example.com)
37
+Your Name <email@example.com> (https://example.com)
38
```
39
40
### Example
@@ -43,7 +43,7 @@ Your Name <email@example.com> (http://example.com)
43
{
44
"name": "my-awesome-package",
45
"version": "1.0.0",
46
- "author": "Your Name <email@example.com> (http://example.com)"
46
+ "author": "Your Name <email@example.com> (https://example.com)"
47
}
48
```
49