Azure / draft-classic

A tool for developers to create cloud-native applications on Kubernetes.
https://draft.sh
MIT License
3.92k stars 398 forks source link

Feedback: The README should be more tech-focused #610

Open bacongobbler opened 6 years ago

bacongobbler commented 6 years ago

I got feedback from a colleague that they didn't fully understand what was Draft until I gave them a demo. Some general feedback was:

I think we can tackle this in two waves:

1) move the video to the bottom 2) Make a smaller, more narrow "Usage" guide in the README, much like the current Getting Started Guide we have in the documentation.

Because a large majority of people reading our README are primarily dev-focused, I think a technical example might be a better format for a README. For example:

keithalpichi commented 6 years ago

I agree. I'd like to add this blog post by Kubernetes as another example to your list https://kubernetes.io/blog/2017/05/draft-kubernetes-container-development.

bacongobbler commented 6 years ago

I'll see if I can tackle this today.