From 26cc9db9df06d8dc8bd80630ece2570d84c8ea80 Mon Sep 17 00:00:00 2001 From: Remy Sharp Date: Mon, 17 Oct 2011 01:07:01 +0100 Subject: [PATCH] updated readme with version info --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 84d5841d..66aaa1a0 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ 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` directory. -# Example +## Example 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 @@ -28,6 +28,42 @@ it's `rem.json`). This file contains a JSON object containing at least a Means I can now link to: http://rem.mit-license.org and it will show my license name (note that the date will always show the current year). -# License +In addition to the `copyright` property, if you want to make a link from +the copyright text, you can include a `url` property: + + { + "copyright": "Remy Sharp, http://remysharp.com", + "url": "http://remysharp.com" + } + +Finally you can also include a license version target in the JSON file +as explained in the next section. + +## License version targeting + +License version targeting allows you to link your MIT license to a +specific revision in this project - therefore fixing it permanently to +a specific license text. + +Though I don't expect the license text to change ever, this is just some +extra assurance for you. + +Targeting requires the [sha from the license commit](https://github.com/remy/mit-license/commits/master/LICENSE.html). This can be +specified on the URL (in your permalink) or in the JSON file. + +For example: [source of http://rem.mit-license.org/a526bf7ad1](view-source:http://rem.mit-license.org/a526bf7ad1) shows an older version of comments inline to the HTML document (compared to the [latest version](view-source:http://rem.mit-license.org)). + +This can also be targeted in my JSON file: + + { + "copyright": "Remy Sharp, http://remysharp.com", + "url": "http://remysharp.com", + "version": "a526rbf7" + } + +Note that if no version is supplied, the latest copy of the LICENSE.html +will be displayed with your information included. + +## License MIT: http://rem.mit-license.org