docs(readme): add documentation regarding salt.formula and salt.master, addressing #326

SamJoan commented 3 years ago

PR progress checklist (to be filled in by reviewers)

[x] Changes to documentation are appropriate (or tick if not required)
[x] Changes to tests are appropriate (or tick if not required)
[x] Reviews completed

What type of PR is this?

Primary type

[ ] [build] Changes related to the build system
[ ] [chore] Changes to the build process or auxiliary tools and libraries such as documentation generation
[ ] [ci] Changes to the continuous integration configuration
[ ] [feat] A new feature
[ ] [fix] A bug fix
[ ] [perf] A code change that improves performance
[ ] [refactor] A code change that neither fixes a bug nor adds a feature
[ ] [revert] A change used to revert a previous commit
[ ] [style] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)

Secondary type

[x] [docs] Documentation changes
[ ] [test] Adding missing or correcting existing tests

Does this PR introduce a `BREAKING CHANGE`?

No.

Related issues and/or pull requests

This addresses #326, small doc change.

Describe the changes you're proposing

Some small documentation to make it easier for new users.

Pillar / config required to test the proposed changes

n/a

Debug log showing how the proposed changes work

n/a

Documentation checklist

[ x] Updated the README (e.g. Available states).
[ ] Updated pillar.example.

Testing checklist

[ ] Included in Kitchen (i.e. under state_top).
[ ] Covered by new/existing tests (e.g. InSpec, Serverspec, etc.).
[ ] Updated the relevant test pillar.

Additional context

dafyddj commented 3 years ago

Hi, and thanks for your contribution. Could you shorten the commit message title to 72 chars as noted by the failing commitlint check?

SamJoan commented 3 years ago

Hi.

I made the changes you requested:

Shortened the commit message.
Used double backticks instead of single backticks.

myii commented 3 years ago

Merged, with an adjusted commit message to satisfy commitlint -- thanks for the contribution, @droope!

SamJoan commented 3 years ago

Oh thank you! awesome 👍🏼

saltstack-formulas-travis commented 3 years ago

:tada: This PR is included in version 1.9.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

saltstack-formulas / salt-formula