search

asetalias / amibot

A Whatsapp bot for Amizone. Powered by the go-amizone API
MIT License
25 stars 16 forks source link

Update README.md #14

Closed ObsidianMaximus closed 2 years ago

ObsidianMaximus commented 2 years ago

Done some correction in sentences and rectified errors in readme.md to the best of my knowledge.

Thank you

ObsidianMaximus commented 2 years ago

Added types-of-contributions.md file with ways in which different section of people can contribute to the project.

ditsuke commented 2 years ago

Thanks for the PR @ObsidianMaximus! I was considering opening an issue to make the make the layout more similar to READMEs for other projects like https://github.com/ditsuke/go-amizone (doesn't need the badges etc). Would you want to give it a shot and make it look more at home?

For some context about why the README is the way it is, excellent documentors as we are we verbatim copied from the project presentation (https://amibot.surge.sh) to save us time :zany_face:

ObsidianMaximus commented 2 years ago

@ditsuke Ok then, will try to document it in a better way.

;)

Although do I need to add technical details? Like for eg from the repo you mentioned, its installation part or any such stuff?

ditsuke commented 2 years ago

Although do I need to add technical details? Like for eg from the repo you mentioned, its installation part or any such stuff?

@ObsidianMaximus Nope, being covered in #13

ObsidianMaximus commented 2 years ago

Although do I need to add technical details? Like for eg from the repo you mentioned, its installation part or any such stuff?

@ObsidianMaximus Nope, being covered in #13

Nice. I'll try to make it look a bit more appealing. :)

ObsidianMaximus commented 2 years ago

@ditsuke can you please specify a license in amibot? would look more better as i am adding it in top ;)

ditsuke commented 2 years ago

@ObsidianMaximus I've added the MIT license to the test branch. Should work once your PR gets merged or if you rebase your branch to test.

ObsidianMaximus commented 2 years ago

@ditsuke sir i have edited the readme and added stuff which i think would suit it the best.

Thank you.

ObsidianMaximus commented 2 years ago

also there is a types-of-contribution.md file in between the commits specifying the ways in which different types of people can contribute to the project.

ObsidianMaximus commented 2 years ago

@ditsuke can you check them now?

Any more suggestions to make them look more beautiful? 😅

ditsuke commented 2 years ago

@ObsidianMaximus thanks, looks good now. Will go ahead and merge it! :rocket:

ObsidianMaximus commented 2 years ago

@ditsuke thanks alot sir! :)