From 294bfbcd1f882524ce5f71bdbe4c8fa19d05cbc0 Mon Sep 17 00:00:00 2001 From: Remy Sharp Date: Sun, 16 Oct 2011 23:29:35 +0100 Subject: [PATCH] updated readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 477d001b..84d5841d 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,20 @@ pleasure. Now I can always include http://rem.mit-license.org in all my projects which links `rem` (the cname) against my copyright holder name `Remy -Sharp` - all stored in the `users.json` file. +Sharp` - all stored in the `users` directory. # Example -The `users.json` file contains a simple database of CNAMEs and copyright -holders, so the following: +The `users` directory contains a list of files, each representing a host +on mit-license.org. As present the file format is very simple, but can +be upgraded in future. + +Create a new file and give it the name of the CNAME you want (in my case +it's `rem.json`). This file contains a JSON object containing at least a +`copyright` property: { - "rem": "Remy Sharp, http://remysharp.com" + "copyright": "Remy Sharp, http://remysharp.com" } Means I can now link to: http://rem.mit-license.org and it will show my