Skip to content

Commit 2cb38f3

Browse files
Grammar fix and prettifications
1 parent f0ee28b commit 2cb38f3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Role to manage users on a system.
1414
* users_default_shell (default: /bin/bash) - the default shell if none is
1515
specified for the user.
1616
* users_create_homedirs (default: true) - create home directories for new
17-
users. Set this to false is you manage home directories separately.
17+
users. Set this to false if you manage home directories separately.
1818

1919
## Creating users
2020

@@ -25,21 +25,21 @@ users to be on certain machines.
2525
The following attributes are required for each user:
2626

2727
* username - The user's username.
28-
* name - The full name of the user (gecos field)
29-
* home - the home directory of the user to create (optional, defaults to /home/username)
28+
* name - The full name of the user (gecos field).
29+
* home - The home directory of the user to create (optional, defaults to /home/username).
3030
* uid - The numeric user id for the user (optional). This is required for uid consistency
3131
across systems.
3232
* gid - The numeric group id for the group (optional). Otherwise, the
33-
uid will be used
33+
uid will be used.
3434
* password - If a hash is provided then that will be used, but otherwise the
35-
account will be locked
35+
account will be locked.
3636
* update_password - This can be either 'always' or 'on_create'
3737
- 'always' will update passwords if they differ. (default)
3838
- 'on_create' will only set the password for newly created users.
39-
* group - optional primary group override
40-
* groups - a list of supplementary groups for the user.
41-
* profile - a string block for setting custom shell profiles
42-
* ssh_key - This should be a list of ssh keys for the user (optional). Each ssh key
39+
* group - Optional primary group override.
40+
* groups - A list of supplementary groups for the user.
41+
* profile - A string block for setting custom shell profiles
42+
* ssh_key - This should be a list of SSH keys for the user (optional). Each SSH key
4343
should be included directly and should have no newlines.
4444
* generate_ssh_key - Whether to generate a SSH key for the user (optional, defaults to no).
4545

0 commit comments

Comments
 (0)