Skip to content
This repository was archived by the owner on Feb 22, 2018. It is now read-only.

Commit b6a3178

Browse files
committed
Merge pull request #8 from dart-lang/pubspec-doc-update
Add author and homepage docs to the pubspec document.
2 parents d82fe35 + 262083b commit b6a3178

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/site/docs/pub-package-manager/pubspec.markdown

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ description: >
2222
Have you been turned into a newt? Would you like to be? This
2323
package can help: it has all of the newt-transmogrification
2424
functionality you've been looking for.
25+
author: Nathan Weizenbaum <[email protected]>
26+
homepage: http://newtify.dartlang.org
2527
dependencies:
2628
efts: '>=2.0.4 <3.0.0'
2729
transmogrify: '>=0.4.0'
@@ -36,6 +38,10 @@ At the top level are a series of fields. The currently supported ones are:
3638
<dd>Required for packages that will be hosted on pub.dartlang.org.</dd>
3739
<dt>Description</dt>
3840
<dd>Required for packages that will be hosted on pub.dartlang.org.</dd>
41+
<dt>Author/Authors</dt>
42+
<dd>Optional.</dd>
43+
<dt>Homepage</dt>
44+
<dd>Optional.</dd>
3945
<dt>Dependencies</dt>
4046
<dd>Can be omitted if your package has no dependencies.</dd>
4147
</dl>
@@ -91,6 +97,30 @@ Think of the description as the sales pitch for your package. Users will see it
9197
when they browse [pub.dartlang.org][pubsite]. It should be simple plain text:
9298
no markdown or HTML. That's what your README is for.
9399

100+
## Author/Authors
101+
102+
You're encouraged to use these fields to describe the author(s) of your package
103+
and provide contact information. `author` should be used if your package has a
104+
single author, while `authors` should be used with a YAML list if more than one
105+
person wrote the package. Each author can either be a single name (e.g. `Nathan
106+
Weizenbaum`) or a name and an email address (e.g. `Nathan Weizenbaum
107+
<[email protected]>`). For example:
108+
109+
{% highlight yaml %}
110+
authors:
111+
- Nathan Weizenbaum <[email protected]>
112+
- Bob Nystrom <[email protected]>
113+
{% endhighlight %}
114+
115+
The authors of a [hosted package](#hosted-packages) will be displayed on
116+
[pub.dartlang.org][pubsite].
117+
118+
## Homepage
119+
120+
This is optional. It should be a URL pointing to the website for your package.
121+
For [hosted packages](#hosted-packages), this URL will be linked from the
122+
package's page on [pub.dartlang.org][pubsite].
123+
94124
## Dependencies
95125

96126
Finally, the pubspec's *raison d'être*: dependencies. Here, you list each

0 commit comments

Comments
 (0)