The current example of formatting in the readme will cause some clients (such as gmail) to only display the text version. The enhanced html version should always be last.
From the Multipart RFC 1341 spec:
In general, user agents that compose multipart/alternative entities should place the body parts in increasing order of preference, that is, with the preferred format last. For fancy text, the sending user agent should put the plainest format first and the richest format last.
The current example of formatting in the readme will cause some clients (such as gmail) to only display the text version. The enhanced html version should always be last.
From the Multipart RFC 1341 spec: