diff --git a/LICENSE b/LICENSE index 52ec1c1..1e89a0b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ - Copyright (c) 2013 Salt Stack Formulas + Copyright (c) 2014 Salt Stack Formulas Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.rst b/README.rst index 50ae8ce..6fdf87a 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,29 @@ +===== users ===== -Configure users via pillar +Formula to configure users via pillar. + + +.. note:: + + See the full `Salt Formulas installation and usage instructions + `_. + +Available states +================ + +.. contents:: + :local: + +``users`` +--------- + +Configure a user's home directory, group, the user itself, secondary groups, +and associated keys. Also configures sudo access, and absent users. + +``users.sudo`` +-------------- + +Ensures the sudo group exists, the sudo package is installed and the sudo file +is configured.