readme and restructure

akerl-archived · Jul 9, 2013 · b148451 · b148451
1 parent fae94bc
commit b148451
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,31 @@
-# Requirements
+totp
+=========
 
-PyYaml (pip install pyyaml)
+This module implements RFC 6238, TOTP authentication.
 
-# Contents
+## Usage
 
-## generate.py
+### generate.py
 
 This script creates the YAML config files for authenticating users. It walks you through the process, and either dumps the results to stdout or a file.
 
-## totp.py
+### totp.py
 
 This handles the config file reading, key manipulation, and code validation. General practice is to instantiate a totp.Config(file) object, get your code, then call Config().authenticate(code) to check it.
 
-## pam.py
+### pam.py
 
-This is designed to work with pam_exec. It handles reading from and writing to the tty to get the code, and returns 0 or 1 to pam_exec to handle authentication.
+This is designed to work with pam\_exec. It handles reading from and writing to the tty to get the code, and returns 0 or 1 to pam\_exec to handle authentication.
 
-## sshd.py
+### sshd.py
 
-This can be used with ForceCommand in sshd_config, and will os.execl the user's shell if successful.
+This can be used with ForceCommand in sshd\_config, and will os.execl the user's shell if successful.
 
+## Requirements
+
+PyYAML
+
+## License
+
+totp is released under the MIT License. See the bundled LICENSE file for details.
 
diff --git a/generate.py → totp/generate.py b/generate.py → totp/generate.py
diff --git a/pam.py → totp/pam.py b/pam.py → totp/pam.py
diff --git a/sshd.py → totp/sshd.py b/sshd.py → totp/sshd.py
diff --git a/totp.py → totp/totp.py b/totp.py → totp/totp.py