fix(README): cleanup the README a bit
Improves the README a bit by using more specific and enabling language.
This commit is contained in:
parent
29b558caec
commit
0a83ef5e23
@ -1,9 +1,9 @@
|
|||||||
# coreos-cloudinit
|
# coreos-cloudinit
|
||||||
|
|
||||||
coreos-cloudinit allows a user to customize CoreOS machines by providing either an executable script or a cloud-config document as instance user-data. See below to learn how to use these features.
|
coreos-cloudinit enables a user to customize CoreOS machines by providing either an executable script or a cloud-config document as instance user-data.
|
||||||
|
|
||||||
## Supported Cloud-Config Features
|
## Supported Cloud-Config Features
|
||||||
|
|
||||||
Only a subset of [cloud-config functionality][cloud-config] is implemented. A set of custom parameters were added to the cloud-config format that are specific to CoreOS, which are [documented here](https://github.com/coreos/coreos-cloudinit/tree/master/Documentation/cloud-config.md).
|
A subset of [cloud-config][cloud-config] is implemented in coreos-cloudinit and is [documented here](https://github.com/coreos/coreos-cloudinit/tree/master/Documentation/cloud-config.md). In addition specific CoreOS paramaters were added for unit files, etcd discovery urls, and others.
|
||||||
|
|
||||||
[cloud-config]: http://cloudinit.readthedocs.org/en/latest/topics/format.html#cloud-config-data
|
[cloud-config]: http://cloudinit.readthedocs.org/en/latest/topics/format.html#cloud-config-data
|
||||||
|
Loading…
Reference in New Issue
Block a user