docs: clean up the README - Githubissues

Azure / kubernetes-keyvault-flexvol

Azure keyvault integration with Kubernetes via a Flex Volume

MIT License

253 stars 84 forks source link

docs: clean up the README #105

Closed mboersma closed 5 years ago

mboersma commented 5 years ago

Reason for Change: Some changes to the README.md to improve navigation and consistency:

Refer to the project consistently as "Key Vault FlexVolume"
Move Getting Started to the top
Add a Contents section
Move most URL targets to the bottom for DRY and readability
Fix lots of markdown linting complaints
Sync with sections from aad-pod-identity README where they overlap
Rewriting of intro and any language that was confusing (to me)

Issue Fixed: Refs #4 See also Azure/kubernetes-kms#48

Notes for Reviewers: This view may be easier to read than the diff.

ritazh commented 5 years ago

LGTM