Rename readme.txt to README.md, fix formatting

beaulebens / keyring-social-importers

A collection of importers which pull your content back from social networks, and into your own WordPress install.

32 stars 17 forks source link

Rename readme.txt to README.md, fix formatting #36

Closed sanmai closed 3 years ago

beaulebens commented 3 years ago

Thanks for the suggestion/PR @sanmai, however this file is actually very intentionally named readme.txt, and formatted this way, because it's intended for consumption by WordPress. I'd be open to adding a new README.md, and maybe targeting it exclusively to developers, however this file is required in its current format for things to work properly with WordPress.

sanmai commented 3 years ago

Fair enough.

What do you think if there would be an automatic conversion procedure for this README.md?
Would it be better to keep this readme.txt, and make a new README.md with a link, pointing towards a place where one can read contents of readme.txt in formatted form?

If I understand correctly, that's the page.