diff --git a/README.md b/README.md index 9852b859..95d4b28f 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ You can send a full JSON file to the API, not *just* the copyright, so this work curl -d'{ "copyright": "Remy Sharp", "url": "http://remysharp.com", "email": "me@mysite.com", "format": "txt" }' http://rem.mit-license.org If there's any problems in the automated creation, send me a pull -request and it'll go live soon after. +request and it'll go live soon after. Equally if you need to update the user file to include more details that you didn't initially include (extra fields in the next section) you will @@ -40,7 +40,7 @@ need to send a pull request on that `user.json` file via GitHub. The `users` directory contains a list of files, each representing a host on mit-license.org. The minimum requirement for the JSON is that is -contains a `copyright` field - everything else is optional. Remember to ensure +contains a `copyright` field - everything else is optional. Remember to ensure the `user.json` file is [valid JSON](http://jsonlint.com/). Available fields: @@ -110,9 +110,9 @@ boolean property: "email": "me@mysite.com", "gravatar": true } - -Note that the gravatar requires the email property. You also need to check the -compatibility of the chosen theme. Currently, only the default theme supports + +Note that the gravatar requires the email property. You also need to check the +compatibility of the chosen theme. Currently, only the default theme supports Gravatar. ### License version targeting @@ -127,7 +127,7 @@ 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: http://rem.mit-license.org/a526bf7ad1 (make sure to view-source) +For example: http://rem.mit-license.org/a526bf7ad1 (make sure to view-source) shows an older version of the LICENSE.html file (compared to the [latest version](http://rem.mit-license.org) - the older version didn't have the new themes). @@ -164,34 +164,17 @@ Current available themes: [@raphaelbastide](http://github.com/raphaelbastide) & [@evertton](http://github.com/evertton)) * flesch - [preview](http://jsbin.com/ufefid/3) (by - [@flesch](http://github.com/flesch) & - [@evertton](http://github.com/evertton)) -* afterdark - [preview](http://jsbin.com/ivufon/4) (by - [@rmartindotco](http://github.com/rmartindotco) & - [@evertton](http://github.com/evertton)) -* orange - [preview](http://jsbin.com/uzubos/2) (by - [@kirbylover4000](http://github.com/kirbylover4000) & - [@evertton](http://github.com/evertton)) + [@flesch](http://github.com/flesch)) +* afterdark - [preview](http://jsbin.com/ivufon/4) (by [@rmartindotco](http://github.com/rmartindotco)) +* orange - [preview](http://jsbin.com/uzubos/2) (by [@kirbylover4000](http://github.com/kirbylover4000)) * plaintext - [preview](http://jsbin.com/uzubos/4) (by [@barberboy](https://github.com/barberboy)) -* double-windsor - [preview](http://jsbin.com/uzubos/5/) (by - [@desandro](https://github.com) & - [@evertton](http://github.com/evertton)) -* cherry - [preview](http://jsbin.com/ufefid/5/) (by - [@mustafa-x](https://github.com/mustafa-x) & - [@evertton](http://github.com/evertton)) -* white cherry - [preview](http://jsbin.com/uzezas/2/) (by - [@mustafa-x](https://github.com/mustafa-x) & - [@evertton](http://github.com/evertton)) -* blackwood - [preview](http://jsbin.com/uzezas/) (by - [@mustafa-x](https://github.com/mustafa-x) & - [@evertton](http://github.com/evertton)) -* hipster-gray - [preview](http://jsbin.com/ivufon/10) (by - [@noformnocontent](https://github.com/noformnocontent) & - [@evertton](http://github.com/evertton)) -* xtansia - [preview](http://jsbin.com/ereren/1/) (by - [@tomass1996](https://github.com/tomass1996) & - [@evertton](http://github.com/evertton)) - +* double-windsor - [preview](http://jsbin.com/uzubos/5/) (by [@desandro](https://github.com)) +* cherry - [preview](http://jsbin.com/ufefid/5/) (by [@mustafa-x](https://github.com/mustafa-x)) +* white cherry - [preview](http://jsbin.com/uzezas/2/) (by [@mustafa-x](https://github.com/mustafa-x)) +* blackwood - [preview](http://jsbin.com/uzezas/) (by [@mustafa-x](https://github.com/mustafa-x)) +* hipster-gray - [preview](http://jsbin.com/ivufon/10) (by [@noformnocontent](https://github.com/noformnocontent)) +* xtansia - [preview](http://jsbin.com/ereren/1/) (by [@tomass1996](https://github.com/tomass1996)) +* magic-mint - [preview](http://jsbin.com/obibot/1/) (by [@ekhager](http://github.com/ekhager)) ## Formats & URLs @@ -213,7 +196,7 @@ The url also supports including a start year: * [http://rem.mit-license.org/2009/](http://rem.mit-license.org/2009/) will show a license year range of 2009-2011 (2011 being the current year) -* [http://rem.mit-license.org/2009-2010](http://rem.mit-license.org/2009-2010/) +* [http://rem.mit-license.org/2009-2010](http://rem.mit-license.org/2009-2010/) allows me to force the year range * [http://rem.mit-license.org/a526bf7ad1/2009-2010/license.txt](http://rem.mit-license.org/a526bf7ad1/2009-2010/license.txt) a526bf7ad1 version, with year range of 2009-2010 in plain text