concourse / registry-image-resource

a resource for images in a Docker registry
Apache License 2.0
89 stars 107 forks source link

Update readme formatting to use tables #317

Closed taylorsilva closed 2 years ago

taylorsilva commented 2 years ago

Trying a new format for the README's for resources. I'm usually looking at the README of a resource to see what params it accepts. I find it difficult to find the params since they blend in with any other blocks of text. They stand out a bit more when they're in a table instead which should make them easier to read.

The tables also make it easier to show that a block of content is attached to a single field. Don't have to worry about markdown indentions as much either.

Also changed the headers to say "Get Step" instead of only "in" . I think it'll make it easier for new users to grok resources since most users don't usually start using Concourse by learning the resource interface.