MIT_LICENSE @@ -2,4 +2,29 @@ GitHub-Unfuddle Bridge ====================== This GitHub-Unfuddle Bridge will automatically create changesets for an Unfuddle process if -it is pointed to by a GitHub post-receive hook. \ No newline at end of file +it is pointed to by a GitHub post-receive hook. + +Setup +===== + +The bridge runs a Sinatra (http://sinatra.rubyforge.org/) server that accepts POSTs to its +root. Simply get the bridge up and running and then point your GitHub projects' post-receive +hooks to it. + +You will need to configure mappings for each github repository to the corresponding +Unfuddle project ID and you will also need mappings of github email addresses to corresponding +Unfuddle user IDs. Right now these will have to be pulled out using the Unfuddle API, a tool +to extract this data more readily will be forthcoming. + +You must also make sure to uncheck the "Unfuddle handles my changesets" box in the project settings. + +Also, this does not yet support 'powerful commits' i.e. closing tickets from a commit message. +Look for this functionality soon. + +More Info +========= + +Project Home: http://github.com/mbleigh/github-unfuddle/ +Contact E-Mail: michael@intridea.com + +Feel free to fork, this is a project in its infancy! \ No newline at end of file README 300afdbbef8bc50dafe2a1da510995246530dcac Michael Bleigh michael@intridea.com http://github.com/mbleigh/github-unfuddle/commit/f443a0854e429b8a114f0c108121206dd4a8e8fb f443a0854e429b8a114f0c108121206dd4a8e8fb 2008-03-24T08:39:30-07:00 2008-03-24T08:39:30-07:00 Updated README, included MIT license. 405f0e1117636dae99a37368fc7e2dad975a81f2 Michael Bleigh michael@intridea.com