From 2ec6a34a11bd87cb893921c0d2fc4759184a98fe Mon Sep 17 00:00:00 2001
From: Orson Peters <orsonpeters@gmail.com>
Date: Tue, 22 Jan 2013 11:34:38 +0100
Subject: [PATCH] docs

---
 readme.md | 71 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 41 insertions(+), 30 deletions(-)

diff --git a/readme.md b/readme.md
index 6525be5..a54c566 100644
--- a/readme.md
+++ b/readme.md
@@ -22,37 +22,46 @@ There are no defined types for seeds, signing keys, verifying keys or
 signatures. Instead simple `unsigned char` buffers are used with the following
 sizes:
 
-    unsigned char seed[32]
-    unsigned char signature[64]
-    unsigned char verify_key[32]
-    unsigned char signing_key[64]
+```c
+unsigned char seed[32];
+unsigned char signature[64];
+unsigned char verify_key[32];
+unsigned char signing_key[64];
+```
 
 API
 ---
 
-    int ed25519_create_seed(unsigned char *seed);
-
+```c
+int ed25519_create_seed(unsigned char *seed);
+```
 Creates a 32 byte random seed in `seed` for key generation. `seed` must be a
 writable 32 byte buffer. Returns 0 on success, and nonzero on failure.
 
-    void ed25519_create_keypair(unsigned char *verify_key, unsigned char *sign_key, const unsigned char *seed);
+```c
+void ed25519_create_keypair(unsigned char *verify_key, unsigned char *sign_key, const unsigned char *seed);
+```
 
 Creates a new key pair from the given seed. `verify_key` must be a writable 32
 byte buffer, `sign_key` must be a writable 64 byte buffer and `seed` must be a
-32 byte buffer.
 
-    void ed25519_sign(unsigned char *signature,
-                     const unsigned char *message, size_t message_len,
-                     const unsigned char *sign_key);
+32 byte buffer.
+```c
+void ed25519_sign(unsigned char *signature,
+                 const unsigned char *message, size_t message_len,
+                 const unsigned char *sign_key);
+```
 
 Creates a signature of the given message with `sign_key`. `signature` must be
 a writable 64 byte buffer. `message` must have at least `message_len` bytes to
 be read. `sign_key` must be a 64 byte signing key generated by
 `ed25519_create_keypair`.
 
-    int ed25519_verify(const unsigned char *signature,
-                       const unsigned char *message, size_t message_len,
-                       const unsigned char *verify_key);
+```c
+int ed25519_verify(const unsigned char *signature,
+                   const unsigned char *message, size_t message_len,
+                   const unsigned char *verify_key);
+```
 
 Verifies the signature on the given message using verify_key. `signature` must be
 a readable 64 byte buffer. `message` must have at least `message_len` bytes to
@@ -61,23 +70,25 @@ be read. `sign_key` must be a 32 byte verifying key generated by
 
 Example
 -------
-    unsigned char seed[32], sign_key[64], verify_key[32], signature[64];
-    const unsigned char message[] = "TEST MESSAGE";
+```c
+unsigned char seed[32], sign_key[64], verify_key[32], signature[64];
+const unsigned char message[] = "TEST MESSAGE";
 
-    /* create a random seed, and a keypair out of that seed */
-    if (ed25519_create_seed(seed)) {
-        printf("error while generating seed\n");
-        exit(1);
-    }
+/* create a random seed, and a keypair out of that seed */
+if (ed25519_create_seed(seed)) {
+    printf("error while generating seed\n");
+    exit(1);
+}
 
-    ed25519_create_keypair(verify_key, sign_key, seed);
+ed25519_create_keypair(verify_key, sign_key, seed);
 
-    /* create signature on the message with the sign key */
-    ed25519_sign(signature, message, strlen(message), sign_key);
+/* create signature on the message with the sign key */
+ed25519_sign(signature, message, strlen(message), sign_key);
 
-    /* verify the signature */
-    if (ed25519_verify(signature, message, strlen(message), verify_key)) {
-        printf("invalid signature\n");
-    } else {
-        printf("valid signature\n");
-    }
\ No newline at end of file
+/* verify the signature */
+if (ed25519_verify(signature, message, strlen(message), verify_key)) {
+    printf("invalid signature\n");
+} else {
+    printf("valid signature\n");
+}
+```
\ No newline at end of file