sjs/mit-license
1
0
Fork 0
mirror of https://github.com/samsonjs/mit-license.git synced 2026-03-31 10:25:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated readme with version info

Browse source
This commit is contained in:
Remy Sharp 2011-10-17 01:07:01 +01:00
parent 4d3400648e
commit 26cc9db9df
1 changed files with 38 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -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