We need a nice README.md

[yusrilia]

Hi! I'm kinda interested to work on this. Although I'm not exactly sure what should I write in the readme, all I know is that this repo is about python and arduino, right?

[ssoto]

Hello @yusrilia! Nice to read you. Yes, this project is a personal project. We need to create a basic web fronted (Flask based) to display device status.

Does it help you?

[ssoto]

Currently we need to support two type of components:

• Relays
• Sensors

Project status now:

• Arduino board is instantiated using a yml field (you can see example in project root dir): Done
• Show each component status: Done using random.randint() ;)
• Write adapter class for each component type: pending
• Write basic web forms to switch relays: pending So on pending.

[yusrilia]

I've never heard of Flask before 😅, but after a little bit of googling, I think I quite got the idea. Since this issue is about writing a readme, I don't think I'm supposed to write the Flask frontend thing, do I?

[ssoto]

I think you can complete our README without know about an API write in Flask (or wathever). Did you ever work with arduino? Can you describe how a relay or sensor works? If yes, let's write it!

[yusrilia]

Yeah, I have. Alright, I'll try! Thanks :)

[hritikgupta]

@ssoto I have a prior experience of working on arduino, relays and sensors. Would love to contribute to the README.

[yusrilia]

sorry, it looks like somebody else had beat me to do it.

[hritikgupta]

No problem @yusrilia, you are free to proceed with it.

[yusrilia]

no it's alright, you can do it @hritikgupta

[ssoto]

Both of you can help with it. Let's do it!

[nloadholtes]

Hi everybody, I submitted a PR with some basic info about the project. Please feel free to add to it!