search

andfanilo / streamlit-drawable-canvas

Do you like Quick, Draw? Well what if you could train/predict doodles drawn inside Streamlit? Also draws lines, circles and boxes over background images for annotation.
https://drawable-canvas.streamlit.app/
MIT License
563 stars 85 forks source link

add setup.install_requires; README example #1

Closed tconkling closed 4 years ago

tconkling commented 4 years ago

Hey @andfanilo ,

This adds the dependencies to setup.py, as before.

I've also modified the README slightly, to include a minimal usage example inline in the file itself (rather than referencing app.py). We haven't figured out what the best practices are around a component's README, but I think including a copy-pasteable minimal example is a good idea, so that someone including the component in their Streamlit app can get up and running quickly.

andfanilo commented 4 years ago

Yeah I agree for the minimal example directly in the README.

I'm still thinking on where I should put API docs and contributing guide, especially for larger components.