Document all options in README.md

[SimonMarquis]

mostly based on CentralPortalOptions docs.

Closes #132

[martinbonnin]

Thanks for opening this! Any thought about "just" putting a big code block with all the CentralPortalOptions possible values?

All options

nmcpAggregation {
  centralPortal {
    // publish manually from the portal
    publishingType = "USER_MANAGED"

    // Increase the validation timeout to 30 minutes
    validationTimeout = Duration.of(30, ChronoUnit.MINUTES)
    // Disable waiting for validation
    validationTimeout = java.time.Duration.ZERO

    // Publish automatically once validation is successful
    publishingType = "AUTOMATIC"

    // Increase the publishing timeout to 30 minutes
    publishingTimeout = Duration.of(30, ChronoUnit.MINUTES)
    // Disable waiting for publishing
    publishingTimeout = java.time.Duration.ZERO

    // Customize the publication name 
    publicationName = "My Awesome Library version $version"
  }
}

I find out my brain is used to reading code blocks and comments more than regular paragraphs. It's definitely in the realm of personal preference though so no strong opinion either way

[SimonMarquis]

That would be great as well. Should I still keep the nmcpZipAggregation appart?

[martinbonnin]

Should I still keep the nmcpZipAggregation appart?

That'd be great, that is something different.

[SimonMarquis]

Let me know if the current version, with these titles and heading is OK for you.

[martinbonnin]

Looks great to me, thanks!