hammerlab / secotrec

Setup Coclobas/Ketrew Clusters
Apache License 2.0
5 stars 6 forks source link

README needs better summary of the project. #39

Open iskandr opened 7 years ago

iskandr commented 7 years ago

The README currently starts like:

Secotrec: Deploy Coclobas/Ketrew with class. secotrec is a library, it provides a bunch of hacks to create more or less generic deployments.

Assume the reader doesn't know what Cocoblas or Ketrew are, can the title describe what Secotrec does without reference to them? Similarly, can we say something more specific about the library's purpose in the first sentence.

As it stands I wouldn't expect anyone who isn't yet initiated to figure this out without a lot of effort.