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

Add author and homepage docs to the pubspec document. #8

Merged
merged 1 commit into from
Sep 19, 2012
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions src/site/docs/pub-package-manager/pubspec.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>
homepage: http://newtify.dartlang.org
dependencies:
efts: '>=2.0.4 <3.0.0'
transmogrify: '>=0.4.0'
Expand All @@ -36,6 +38,10 @@ At the top level are a series of fields. The currently supported ones are:
<dd>Required for packages that will be hosted on pub.dartlang.org.</dd>
<dt>Description</dt>
<dd>Required for packages that will be hosted on pub.dartlang.org.</dd>
<dt>Author/Authors</dt>
<dd>Optional.</dd>
<dt>Homepage</dt>
<dd>Optional.</dd>
<dt>Dependencies</dt>
<dd>Can be omitted if your package has no dependencies.</dd>
</dl>
Expand Down Expand Up @@ -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
<[email protected]>`). For example:

{% highlight yaml %}
authors:
- Nathan Weizenbaum <[email protected]>
- Bob Nystrom <[email protected]>
{% 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
Expand Down