chore: add README

[mcturco]

Adding README file as suggested by @alequetzalli 🙌

If there is anything I should tweak let me know!

(Resolves #14)

[mcturco]

Also - looking at the README in preview mode within the commit and for some reason the image is showing up as broken, but it is linked correctly so I'm not sure why! Here is the preview from VS Code

[quetzalliwrites]

Hey there! The first thing I would recommend is that you remove all of the unnecessary HTML tags you added because this file is a markdown file so you don't need to put those. 😄 are you familiar with markdown syntax?

https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

Here's how you will need to update your table + guidance on using markdown syntax for tables:

https://www.markdownguide.org/extended-syntax/

You will probably also want to bookmark the following markdown table generator because it will make your life easier:

https://www.tablesgenerator.com/markdown_tables

[quetzalliwrites]

Also - looking at the README in preview mode within the commit and for some reason the image is showing up as broken, but it is linked correctly so I'm not sure why! Here is the preview from VS Code

As part of the changes you need to make to remove the HTML tags and use only markdown syntax, I would go ahead and use the markdown syntax for images too. 😀

Btw, I just wanted to assure you that I don't see img in preview mode in my own PR work either, so I don't think you did it wrong. This is what I normally see too. 🤔

Worse case, after you update this PR w/ markdown syntax, we can ask Lukasz 🙊

[mcturco]

Hey @alequetzalli! Thanks! Yeah I was wondering if I should have only used the mark down syntax but I was referencing the README in the community repo and I saw HTML tags so I thought it would be okay!

No worries though, its probably better anyway if I use the correct syntax. I will work on that now and then tag you again when its ready for review! 😄

[mcturco]

@alequetzalli okay! We should be all set now, I updated the format to markdown only 😄

[quetzalliwrites]

Hey @alequetzalli! Thanks! Yeah I was wondering if I should have only used the mark down syntax but I was referencing the README in the community repo and I saw HTML tags so I thought it would be okay!

Ahhh I know what you mean... not to throw anyone under the bus but all of those HTML tags for the images and sponsors in the community repo README was made by Lukasz 😂... when I edited that file I only improved it and didn't really take the time to look at fixing that stuff.

I think a good README example is the Initiative's README, from what I remember that one was completely rewritten and cleaned out, so it should only have proper markdown syntax 🙂👍🏽

https://github.com/asyncapi

[mcturco]

@alequetzalli

I think a good README example is the Initiative's README, from what I remember that one was completely rewritten and cleaned out, so it should only have proper markdown syntax 🙂👍🏽

Definitely! Yeah I started looking at that one this morning when I was changing up the syntax. I agree with you that the markdown syntax is MUCH cleaner in this case!

[mcturco]

@alequetzalli thank you! Just committed all your suggestions. LMK if it looks all good!

[quetzalliwrites]

@mcturco Hmmm... I think something might be off in the settings for this PR? the /rtm script that Lukasz made doesn't seem to work.. or... also there is a note that states you are not authorized to merge

what do you think, missy? 🤔

[fmvilas]

Only @mcturco and I are code owners of this repo so that's why the /rtm command is not working. I first have to approve.