Skip to content

Commit

Permalink
docs: clarify package name rules (#1326)
Browse files Browse the repository at this point in the history
- Add missing information as per Issue #1295 
- use secure hyperText Transfer Protocol : https

---------

Co-authored-by: Gar <[email protected]>
  • Loading branch information
kenshanta and wraithgar authored Oct 14, 2024
1 parent a711a5b commit 6cd32d8
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ A `package.json` file:

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

The `"name"` field contains your package's name, and must be lowercase and one word, and may contain hyphens and underscores.
The `"name"` field contains your package's name and *must* be lowercase *without* any spaces. May contain _hyphens_, _dots_, and _underscores_.

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

### Author field

If you want to include package author information in `"author"` field, use the following format (email and website are both optional):
If you want inclusive package author information, in the `"author"` field use the following format (email and website are both optional):

```
Your Name <[email protected]> (http://example.com)
Your Name <[email protected]> (https://example.com)
```

### Example
Expand All @@ -43,7 +43,7 @@ Your Name <[email protected]> (http://example.com)
{
"name": "my-awesome-package",
"version": "1.0.0",
"author": "Your Name <[email protected]> (http://example.com)"
"author": "Your Name <[email protected]> (https://example.com)"
}
```

Expand Down

0 comments on commit 6cd32d8

Please sign in to comment.