UPDATE January 2020:
The button now supports Salesforce DX source format! See here for more details.
The GitHub Salesforce Deployment tool has been one of my most successful tools to date, i’m really pleased with it and how well it has been adopted. You can read more about the inspiration and background to the tool in my original blog post here.
I recently received a very nice submission to improve the visuals of the tool when invoking it from a GitHub Readme file, in the form of the Deploy to Salesforce button image! Big thanks to Karanrajs for creating it, it looks great! I have now integrated it into the main repository and given repository owners a nice utility feature to copy and paste the required HTML markup to embed in their README files.
To use it go to the main page of the here tool, enter your details and click the Show GitHub README button code checkbox, then copy paste the code into your README file, i usually place under the title then sit back and enjoy!
For example the README file for the Apex Metadata API repository now looks like this…
Apex Wrapper Salesforce Metadata API ==================================== <a href="https://githubsfdeploy.herokuapp.com?owner=financialforcedev&repo=apex-mdapi"> <img src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/src/main/webapp/resources/img/deploy.png" alt="Deploy to Salesforce" /> </a>
When displayed on the repository main page, we now see a shiny new button!