From 02e00f92bad97ae6ab2decf7dcecf41b7900b2fe Mon Sep 17 00:00:00 2001 From: Daniel Dimitrov Date: Sat, 23 Jun 2012 20:58:12 +0200 Subject: [PATCH] adding README --- README | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..d484366 --- /dev/null +++ b/README @@ -0,0 +1,13 @@ +JEDchecker + +This extension is able to check your components, modules or plugins for common errors that will prevent you +from publishing your extension on the JED. + +If you want to write a rule have a look a the library/rules folder. + +You just need to add a new file with your rule. Example: +yourrule.php + +"yourrule.php" needs to have a class jedcheckerRulesYourrule and that class needs to have a +function that accepts the basedir as parameter. This is all - the component will automatically call +your rule check function. \ No newline at end of file