aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@googlemail.com>2012-12-02 13:30:22 +0000
committerDominik Picheta <dominikpicheta@googlemail.com>2012-12-02 13:30:22 +0000
commit7a6d85710aa1a949e8093bf2667905d9d6debb10 (patch)
tree985e4da69224880ff504067d81b4e3edfa82ea4a
parent25448614cf78d0752821e1349047ed3a5f7dc52d (diff)
downloadpackages-7a6d85710aa1a949e8093bf2667905d9d6debb10.tar.gz
packages-7a6d85710aa1a949e8093bf2667905d9d6debb10.zip
Added proper readme.
-rw-r--r--README.md22
-rw-r--r--packages.json2
2 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index 44fa9b0..bbf0874 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
# Nimrod packages
-This repository provides a list packages for babel. \ No newline at end of file
+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. \ No newline at end of file
diff --git a/packages.json b/packages.json
index 34f77d3..dcb7223 100644
--- a/packages.json
+++ b/packages.json
@@ -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."
}
] \ No newline at end of file