Add README for this project

[anubha-v-ardhan]

Edit the README and include details on the following (and more if needed)

• What is this project
• Why is this project needed
• How is this project built and what all can it do (This project is based on GitHub Action twitter-together)
• Steps to post a new tweet
• How to contribute (Link to CONTRIBUTING.md)
• Credits to kubernetes-sigs/contributor-tweets for inspiring this project
• Code of Conduct (Link to code-of-conduct.md)

[dipankardas011]

Can i try

[mkgupta01]

You can assign this to me.

[dipankardas011]

lets both do

[dipankardas011]

@mayankkuamr001 what do you say

[mkgupta01]

@dipankardas011 Yay,why not

[dipankardas011]

Nice

[dipankardas011]

So I am sending the initial commit then you can continue

[shaggyyy2002]

https://www.makeareadme.com/ you can use this tool

[dipankardas011]

@mayankkuamr001 #4

[dipankardas011]

Ig you can edit it

[dipankardas011]

Or you can use My repo branch

[saiyam1814]

Try it once the code is working , the Readme should have the steps for posting the Tweet!

[mkgupta01]

Okay

[rishavmehra]

Can you guys explain me the full working of this project, I'm also want to work on this project

[anubha-v-ardhan]

Hello @dipankardas011 @mayankkuamr001!
Any update on the work?

[dipankardas011]

@anubha-v-ardhan just making the template like for the readme so that in future we can edit it??

[anubha-v-ardhan]

We'd prefer a final PR, Since there are multiple folks working on this issue, you can use platforms like Google Docs or HackMD for collaboration but if you prefer making a placeholder PR and then working on it, I guess it's fine too. (cc @saiyam1814)

Also @BushraNazish has some content ready on #13. We all may use that PR to add more required stuff.

At the end there should be one PR with README.md which folks can review and can be merged.

[dipankardas011]

👍🏼

[BushraNazish]

We'd prefer a final PR, Since there are multiple folks working on this issue, you can use platforms like Google Docs or HackMD for collaboration but if you prefer making a placeholder PR and then working on it, I guess it's fine too. (cc @saiyam1814)

Also @BushraNazish has some content ready on #13. We all may use that PR to add more required stuff.

At the end there should be one PR with README.md which folks can review and can be merged.

Any updates on adding the new features in README file folks?? @dipankardas011 @mayankkuamr001
Hope you all have seen the instructions from @saiyam1814 in Tweets Project thread, it goes as :
we need to explain about the project, tell the complete flow, create a small architecture diagram

[dipankardas011]

Okay I will be seeing it

[BushraNazish]

Great 👍
We can discuss the workflow as well

[dipankardas011]

@BushraNazish Can you create a google docs file for editing the Readme.md?
OR
should I be sharing the link?
and Also @mayankkuamr001

[mkgupta01]

@dipankardas011 you can share the link

[dipankardas011]

okay

[dipankardas011]

@mayankkuamr001 @BushraNazish
Link: https://docs.google.com/document/d/1leCN4eqI-BbGEPqXTvrO0PLRFsp7tDH94IsQXsvhOaQ/edit?usp=sharing

[BushraNazish]

Thanks for sharing the link @mayankkuamr001 👍

[dipankardas011]

Thinking of refining more🙂

[dipankardas011]

@BushraNazish can you create a new branch for the PR want to add the edited readme so that all can review

[BushraNazish]

Yes @dipankardas011 I will try to do it

[dipankardas011]

@BushraNazish created a PR to your update branch

[BushraNazish]

@dipankardas011 Great job. Merged done !!