Skip to content

Commit 6cd32d8

Browse files
kenshantawraithgar
andauthored
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>
1 parent a711a5b commit 6cd32d8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

content/packages-and-modules/contributing-packages-to-the-registry/creating-a-package-json-file.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ A `package.json` file:
2525

2626
A `package.json` file must contain `"name"` and `"version"` fields.
2727

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_.
2929

3030
The `"version"` field must be in the form `x.x.x` and follow the [semantic versioning guidelines][semver].
3131

3232
### Author field
3333

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):
3535

3636
```
37-
Your Name <email@example.com> (http://example.com)
37+
Your Name <email@example.com> (https://example.com)
3838
```
3939

4040
### Example
@@ -43,7 +43,7 @@ Your Name <email@example.com> (http://example.com)
4343
{
4444
"name": "my-awesome-package",
4545
"version": "1.0.0",
46-
"author": "Your Name <email@example.com> (http://example.com)"
46+
"author": "Your Name <email@example.com> (https://example.com)"
4747
}
4848
```
4949

0 commit comments

Comments
 (0)