Add documentation

jpf · Feb 28, 2017 · 201bec1 · 201bec1
1 parent ecf7ca9
commit 201bec1
Show file tree

Hide file tree

Showing 4 changed files with 1,289 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+*.pyc
+*~
+dist/
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# lokey
+
+lokey a tool to convert between different cryptographic key formats.
+
+At the moment, lokey can convert RSA keys between the following
+formats: openssh, X.509  Certificates, PGP, and JWT.
+
+With lokey you can:
+-   Use the public SSL certicate of a website to send an S/MIME
+    encrypted email to any website owner that uses TLS:
+-   Grant access to your a server by turning your friend's keybase key
+    into an openssh key
+
+Named after the shape shifting and mischief-making Trickster from Norse mythology, this tool serves to test the bounds of possiblities and order.
+
+## Install
+
+    pip install lokey
+
+## Learn more
+
+    lokey --help
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    *.pyc
+    *~
+    dist/