diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 7 insertions, 5 deletions
@@ -9,7 +9,7 @@ To add your own package, fork this repository, edit packages.json and make a pull request. Packages.json is a simple array of objects. Each package object should have the -following fields: +following fields (unless the field is marked as optional): * name - The name of the package, this should match the name in the package's babel file. @@ -19,8 +19,10 @@ following fields: * tags - A list of tags describing this package. * description - A description of this package. * license - The license of the source code in the package. + * web - An optional url for humans to read additional information about + the package. -Your packages may be removed if the url stops working. It goes without -saying that your pull request will not be accepted unless you fill out all of -the above fields correctly, the package that ``url`` points to must also contain -a babel file, or else it will be rejected. +Your packages may be removed if the url stops working. It goes without saying +that your pull request will not be accepted unless you fill out all of the +above required fields correctly, the package that ``url`` points to must also +contain a babel file, or else it will be rejected. |