Skip to content

Commit 350619f

Browse files
committed
Don't set a homepage unless it's special. Fixes #26
1 parent c7a5907 commit 350619f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1046,16 +1046,25 @@ all the things"].
10461046
<a id="c-metadata"></a>
10471047
### Cargo.toml includes all common metadata (C-METADATA)
10481048

1049+
The `[package]` section of `Cargo.toml` should include the following
1050+
values:
1051+
10491052
- `authors`
10501053
- `description`
10511054
- `license`
1052-
- `homepage` (though see [rust-api-guidelines#26](https://github.com/brson/rust-api-guidelines/issues/26))
10531055
- `documentation`
10541056
- `repository`
10551057
- `readme`
10561058
- `keywords`
10571059
- `categories`
10581060

1061+
`Cargo.toml` also allows for a `homepage` value. This should only be
1062+
filled in if there is a unique website for the crate other than the
1063+
source repository or API documentation. Do not make `homepage`
1064+
redundant with either the `documentation` or `repository` values. For
1065+
example, serde sets `homepage` to "https://serde.rs", a dedicated
1066+
website.
1067+
10591068
[C-DOCS-RS]: #c-docs-rs
10601069
<a id="c-docs-rs"></a>
10611070
### Cargo.toml documentation key points to docs.rs (C-DOCS-RS)

0 commit comments

Comments
 (0)