diff --git a/src/site/docs/pub-package-manager/pubspec.markdown b/src/site/docs/pub-package-manager/pubspec.markdown index d1135da9d..21edbe329 100644 --- a/src/site/docs/pub-package-manager/pubspec.markdown +++ b/src/site/docs/pub-package-manager/pubspec.markdown @@ -22,6 +22,8 @@ description: > Have you been turned into a newt? Would you like to be? This package can help: it has all of the newt-transmogrification functionality you've been looking for. +author: Nathan Weizenbaum +homepage: http://newtify.dartlang.org dependencies: efts: '>=2.0.4 <3.0.0' transmogrify: '>=0.4.0' @@ -36,6 +38,10 @@ At the top level are a series of fields. The currently supported ones are:
Required for packages that will be hosted on pub.dartlang.org.
Description
Required for packages that will be hosted on pub.dartlang.org.
+
Author/Authors
+
Optional.
+
Homepage
+
Optional.
Dependencies
Can be omitted if your package has no dependencies.
@@ -91,6 +97,30 @@ Think of the description as the sales pitch for your package. Users will see it when they browse [pub.dartlang.org][pubsite]. It should be simple plain text: no markdown or HTML. That's what your README is for. +## Author/Authors + +You're encouraged to use these fields to describe the author(s) of your package +and provide contact information. `author` should be used if your package has a +single author, while `authors` should be used with a YAML list if more than one +person wrote the package. Each author can either be a single name (e.g. `Nathan +Weizenbaum`) or a name and an email address (e.g. `Nathan Weizenbaum +`). For example: + +{% highlight yaml %} +authors: +- Nathan Weizenbaum +- Bob Nystrom +{% endhighlight %} + +The authors of a [hosted package](#hosted-packages) will be displayed on +[pub.dartlang.org][pubsite]. + +## Homepage + +This is optional. It should be a URL pointing to the website for your package. +For [hosted packages](#hosted-packages), this URL will be linked from the +package's page on [pub.dartlang.org][pubsite]. + ## Dependencies Finally, the pubspec's *raison d'ĂȘtre*: dependencies. Here, you list each