[Docs] Make use of GitHub readme.MD

[majick777]

Is your feature request related to a problem? Please describe. Currently we are just displaying the existing WordPress plugin readme.txt as the GitHub repository description. This is shown automatically as it exists and is okay - but a much richer experience is possible.

Describe the solution you'd like We can use the readme.MD to add graphics, relevent links and other product information for the project at the top of the readme.MD file - with the existing readme.txt info below that.

Describe alternatives you've considered Unfortunately GitHub only automatically reads one file and displays that (readme.MD takes priority over readme.txt) - so this would mean updating the appended readme.txt information each time that is changed also.

[majick777]

@tonyzeoli while on this topic, a minor change that needs doing is that you can edit the GitHub repository description at the top of the main repo page, the current one is pulled from the plugin mirror repo. Unforunately the Edit link is not available to me for this. I have changed my fork repo description to simply: "Radio Station Plugin https://netmix.com/radio-station/"

[tonyzeoli]

@majick777 I've edited and changed to "Radio Station WordPress Plugin (Open Source)" and simply changed the link to the website from what it was to just https://netmix.com.

There are GitHub flavored markup rules for the read.MD file, which I found, but it's way too complex for me to learn right now - I know I should just review it and keep it in mind.

But I also found there are editors to write read.MD files, as well. I found one referenced here, https://www.markdownguide.org/getting-started/

They say to use https://dillinger.io/, so I should be able to use this.

My question is, if I create the read.MD file, does that translate on the WordPress site in the text editor, as well? I think there's the markdown option checkbox right? I can use Markdown in the post page too, correct?

[tonyzeoli]

@trystant Just checking in on the status of the readme.md progress. Let us know. Thanks, Mark.

[tonyzeoli]

@trystant Just following up here on the Git Issue. Let us know where you're at here. We're going to need to add screenshots too. @majick777 can take them as he's working on 2.3.0. We'll probably need to add FAQs for 2.3.0 as well.

[trystant]

So there should be a PR for this at this point. Take a look & let me know what you think. Thanks.

[tonyzeoli]

Great, will take a look my brother!

On Sun, Dec 1, 2019 at 6:50 PM Mark Nyon notifications@github.com wrote:

So there should be a PR for this at this point. Take a look & let me know what you think. Thanks.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/netmix/radio-station/issues/61?email_source=notifications&email_token=AA65WOYK3GMOFNTAGOGYWSLQWREU3A5CNFSM4IZ35SIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFRZYAY#issuecomment-560176131, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA65WO544HNEUOQU2JKV6FLQWREU3ANCNFSM4IZ35SIA .

[majick777]

Just a follow up point on this one, we can still be adding image displays to the readme.md file so that they show up on the repository page.

[tonyzeoli]

@majick777 Let me know where we are with this. Thanks.

[majick777]

@tonyzeoli Basically just need to decide what plugin images or other promotional material/text (eg. mention of the Netmix Directory and images?) we want to put in this space, as the repository "home" page in a send, I still think we can make better use of it and make it look prettier by having images etc. (but not adding too many links.) I can do the markdown formatting for this once we have some images and copy to put there so maybe you can do a draft for that and I can incorporate it into the readme.md ... we can keep it simple to begin with.