diff --git a/README.md b/README.md index d96656adac497190c21fbf4a506be614f53e58d6..0ff548aca63d2c9f6af7e2a6945c02dfa5950595 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,21 @@ It is advised that kadmin_local is used for rapid unpacked iteration, other task ##Examples: +###Principal Creation: + +```python +>>> +>>> # ank, addprinc, add_principal are all aliases for principal creation +>>> # omitting a password or setting to None results in a randomized key +>>> # kadm.ank(principal [, password|None] [, db_args=db_args]) +>>> +>>> kadm.ank("user@EXAMPLE.COM", "correcthorsebatterysaple") +>>> kadm.addprinc("user@EXAMPLE.COM", None) +>>> # +>>> kadm.add_principal("user@EXAMPLE.COM", None, db_args={'dn':'uid=user,ou=people,dc=example,dc=com'}) +>>> +``` + ###Principal Attributes: ```python >>> princ = kadm.getprinc("user@EXAMPLE.COM")