Permalink
Browse files

Added the readme file

  • Loading branch information...
1 parent ccafd05 commit bfd70413d1fb0f7bade1067fc68e8a1191cd0928 Mert Yazicioglu committed Feb 5, 2012
Showing with 12 additions and 0 deletions.
  1. +12 −0 README.md
View
@@ -0,0 +1,12 @@
+Simple Commit Notifier
+======================
+
+Simple Commit Notifier is a Post-Receive URL implementation to send emails containing commit information.
+
+Usage
+-----
+
+* Fill in the settings inside the `index.php` file.
+* Fill in the `contacts` file with the email addresses you want to send an email to after each commit. There should be only one email address per line.
+* Fill in the `trusted repos` file with the names of the repositories you want this script to work for. There should be only one repository name per line.
+* Fill in the `header.html` and `footer.html` files to prepend and append your emails with some HTML content.

0 comments on commit bfd7041

Please sign in to comment.