From fc9fcc094f19cfcb45c659928755f1c19ece87cc Mon Sep 17 00:00:00 2001 From: "Jan T. Sott" Date: Mon, 12 Jan 2015 14:57:01 +0100 Subject: [PATCH] updated description --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cd9e738..d92a231 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,34 @@ -# Creative Commons 4.0 Markdown Licenses +# Creative Commons 4.0 Markdown On November 25th, 2013, [Creative Commons](http://creativecommons.org/) announced their next generation licenses: [Creative Commons 4.0](https://creativecommons.org/weblog/entry/40768). By default, these are available as [HTML](http://creativecommons.org/licenses/) or [plaintext](http://creativecommons.org/weblog/entry/41127). This project adds [Markdown](http://daringfireball.net/projects/markdown/)-formatted licenses to that list. +Unfortunately, the output currently varies on different Markdown viewers, in particular when it comes to indentation levels. You can choose between these two branches: + +* [Tabulator indentation](https://github.com/idleberg/Creative-Commons-4.0-Markdown/tree/tabulators/licenses) might cause some blocks to be interpreted as code (e.g. on GitHub) + +* [Space indentation](https://github.com/idleberg/Creative-Commons-4.0-Markdown/tree/spaces/licenses) results in less readable files when viewed as plain text + +Hopefully the [CommonMark](http://commonmark.org/) specification will sort out these issues in the future. + +## Licenses + +* `BY` [Attribution](licenses/by.markdown) +* `BY-NC` [Attribution-NonCommercial](licenses/by-nc.markdown) +* `BY-NC-ND` [Attribution-NonCommercial-NoDerivatives](licenses/by-nc-nd.markdown) +* `BY-NC-SA` [Attribution-NonCommercial-ShareAlike](licenses/by-nc-sa.markdown) +* `BY-ND` [Attribution-NoDerivatives](licenses/by-nd.markdown) +* `BY-SA` [Attribution-ShareAlike](licenses/by-sa.markdown) +* `C0` [CC0](licenses/zero.markdown) + ## File extension +There's a plethora of Markdown file extensions, but I have decided to go with `markdown`. Read why: + *"We no longer live in a 8.3 world, so we should be using the most descriptive file extensions. It’s sad that all our operating systems rely on this stupid convention instead of the better creator code or a metadata model, but great that they now support longer file extensions."* -Hilton Lipschitz ([via](http://hiltmon.com/blog/2012/03/07/the-markdown-file-extension/)) +Hilton Lipschitz ([via](http://hiltmon.com/blog/2012/03/07/the-markdown-file-extension/)) *"…the only file extension I would endorse is “.markdown”, for the same reason offered by Hilton Lipschitz"* -John Gruber, creator of Markdown ([via](http://daringfireball.net/linked/2014/01/08/markdown-extension)) - -Alas, it might seem ironic to you, that *this* file uses the `.md` extension. +John Gruber, creator of Markdown ([via](http://daringfireball.net/linked/2014/01/08/markdown-extension)) ## Contribute