Added proper readme.

This commit is contained in:
Dominik Picheta 2012-12-02 13:30:22 +00:00
parent 25448614cf
commit 7a6d85710a
2 changed files with 22 additions and 2 deletions

View File

@ -1,3 +1,23 @@
# Nimrod packages
This repository provides a list packages for babel.
This is a central listing of all packages for babel.
## Adding your own package
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:
* name - The name of the package, this should match the name in the package's
babel file.
* url - The url from which to retrieve the package.
* method - The method that should be used to retrieve this package. Currently
only "git" is supported.
* tags - A list of tags describing this package.
* description - A description of this 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.

View File

@ -4,6 +4,6 @@
"url": "git://github.com/dom96/jester/",
"method": "git",
"tags": ["web", "http", "framework", "dsl"],
"description": "Web Framework inspired by Sinatra."
"description": "A sinatra-like web framework for Nimrod."
}
]