deshack / pinit

Handy plugin that adds Pinterest Follow Button, Pin Widget, Profile Widget and Board Widget to your WordPress site.
GNU General Public License v2.0
4 stars 2 forks source link

Create README.md #10

Closed deshack closed 8 years ago

deshack commented 8 years ago

readme.txt is required by WordPress, but not rendered by GitHub. In order to improve the plugin presentation on GitHub too, we should create a README.md.

EugenioPetulla commented 8 years ago

My suggestion is to setup a good and catchy WordPress readme and after convert it using this elegant tool: https://github.com/benbalter/WP-Readme-to-Github-Markdown

:)

deshack commented 8 years ago

I didn't remember about this tool, but it's good for me.

EugenioPetulla commented 8 years ago

Done! Let's have a check if this solution it's good for you but personally I really love it! One click and it's all ready.

I found also a Sublime Text extension that could be ported everywhere because is written in Py (I tried also using it in geany and it worked well too). Give it a try: https://github.com/claudiosmweb/wordpress-readme-to-markdown

EugenioPetulla commented 8 years ago

README.md provided with commit: 239135a545105639e01d270503f7ab81e76d0898