diff --git a/README.md b/README.md index e7dc8f8..576a988 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -Black Friday -============ +Blackfriday +=========== This is an implementation of John Gruber's [markdown][1] in [Go][2]. It is a translation of the [upskirt][3] library written in C with a @@ -40,7 +40,7 @@ All features of upskirt are supported, including: * The Markdown v1.0.3 test suite passes with the `--tidy` option. Without `--tidy`, the differences appear to be bugs/dubious - features in the original. + features in the original, mostly related to whitespace. * Common extensions, including table support, fenced code blocks, autolinks, strikethroughs, non-strict emphasis, etc. @@ -52,9 +52,9 @@ All features of upskirt are supported, including: errors that were present in the C code). * Good performance. I have not done rigorous benchmarking, but - informal testing suggests it is around 3.5x slower than upskirt. + informal testing suggests it is around 3--4x slower than upskirt. -* Minimal dependencies. blackfriday only depends on standard +* Minimal dependencies. Blackfriday only depends on standard library packages in Go. The source code is pretty self-contained, so it is easy to add to any project. @@ -98,6 +98,38 @@ Todo * Markdown pretty-printer output engine +License +------- + +Blackfriday is distributed under the Simplified BSD License: + +> Copyright © 2011 Russ Ross . All rights reserved. +> +> Redistribution and use in source and binary forms, with or without modification, are +> permitted provided that the following conditions are met: +> +> 1. Redistributions of source code must retain the above copyright notice, this list of +> conditions and the following disclaimer. +> +> 2. Redistributions in binary form must reproduce the above copyright notice, this list +> of conditions and the following disclaimer in the documentation and/or other materials +> provided with the distribution. +> +> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR IMPLIED +> WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +> FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL OR +> CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +> CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +> SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +> ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +> NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +> ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +> +> The views and conclusions contained in the software and documentation are those of the +> authors and should not be interpreted as representing official policies, either expressed +> or implied, of the copyright holder. + + [1]: http://daringfireball.net/projects/markdown/ "Markdown" [2]: http://golang.org/ "Go Language" [3]: http://github.com/tanoku/upskirt "Upskirt" diff --git a/block.go b/block.go index 669205a..11b5c4f 100644 --- a/block.go +++ b/block.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/block_test.go b/block_test.go index ae75f2b..5e9f654 100644 --- a/block_test.go +++ b/block_test.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/example/main.go b/example/main.go index 8250a44..8ff7955 100644 --- a/example/main.go +++ b/example/main.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/html.go b/html.go index cf3cbf6..a301097 100644 --- a/html.go +++ b/html.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/inline.go b/inline.go index 62dffd2..da20800 100644 --- a/inline.go +++ b/inline.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/inline_test.go b/inline_test.go index b8680bd..957cfee 100644 --- a/inline_test.go +++ b/inline_test.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/latex.go b/latex.go index 7d2763f..9c1935a 100644 --- a/latex.go +++ b/latex.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // @@ -304,7 +307,7 @@ func latexDocumentHeader(out *bytes.Buffer, opaque interface{}) { out.WriteString(" urlcolor=black,%\n") out.WriteString(" pdfstartview=FitH,%\n") out.WriteString(" breaklinks=true,%\n") - out.WriteString(" pdfauthor={Black Friday Markdown Processor}}\n") + out.WriteString(" pdfauthor={Blackfriday Markdown Processor}}\n") out.WriteString("\n") out.WriteString("\\newcommand{\\HRule}{\\rule{\\linewidth}{0.5mm}}\n") out.WriteString("\\addtolength{\\parskip}{0.5\\baselineskip}\n") diff --git a/markdown.go b/markdown.go index a03a33d..ac9e941 100644 --- a/markdown.go +++ b/markdown.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/smartypants.go b/smartypants.go index d1a75b7..bbd2b6d 100644 --- a/smartypants.go +++ b/smartypants.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // // diff --git a/upskirtref_test.go b/upskirtref_test.go index 74e2be9..5a47f4f 100644 --- a/upskirtref_test.go +++ b/upskirtref_test.go @@ -1,7 +1,10 @@ // -// Black Friday Markdown Processor -// Originally based on http://github.com/tanoku/upskirt -// by Russ Ross +// Blackfriday Markdown Processor +// Available at http://github.com/russross/blackfriday +// +// Copyright © 2011 Russ Ross . +// Licensed under the Simplified BSD License. +// See README.md for details. // //