From 797521701ec5ca74f146f4f8bac19edc65c9d24f Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Wed, 5 Mar 2014 16:24:03 +0100 Subject: [PATCH] licensing and acknowledgement fixes #34 --- GithubMarkdown.php | 9 ++++++--- LICENSE | 2 +- Markdown.php | 7 +++++-- Parser.php | 7 +++++-- README.md | 19 ++++++++++++++++++- bin/markdown | 5 +++++ tests/BaseMarkdownTest.php | 9 +++++++-- tests/GithubMarkdownTest.php | 7 +++++++ tests/MarkdownTest.php | 8 +++++++- tests/profile.php | 3 --- 10 files changed, 61 insertions(+), 15 deletions(-) diff --git a/GithubMarkdown.php b/GithubMarkdown.php index 86371e8..0efc980 100644 --- a/GithubMarkdown.php +++ b/GithubMarkdown.php @@ -1,13 +1,16 @@ - * @license https://github.com/cebe/markdown/blob/master/LICENSE - * @link https://github.com/cebe/markdown#readme */ class GithubMarkdown extends Markdown { diff --git a/LICENSE b/LICENSE index d216c3c..acc225d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) [year] [fullname] +Copyright (c) 2014 Carsten Brandt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/Markdown.php b/Markdown.php index 3c3728b..d5a9359 100644 --- a/Markdown.php +++ b/Markdown.php @@ -1,4 +1,9 @@ - * @license https://github.com/cebe/markdown/blob/master/LICENSE - * @link https://github.com/cebe/markdown#readme */ class Markdown extends Parser { diff --git a/Parser.php b/Parser.php index 7cdcec6..73ae7b5 100644 --- a/Parser.php +++ b/Parser.php @@ -1,4 +1,9 @@ - * @license https://github.com/cebe/markdown/blob/master/LICENSE - * @link https://github.com/cebe/markdown#readme */ class Parser { diff --git a/README.md b/README.md index 9f87d90..1dcf62c 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,12 @@ Future plans are to support: ### Who is using it? -- It powers the API-docs and the definitive guide for the [Yii Framework][] [2.0](https://github.com/yiisoft/yii2). Pre-beta preview is hosted here: http://stuff.cebe.cc/yii2docs/guide_index.html +- It powers the API-docs and the definitive guide for the [Yii Framework][] [2.0](https://github.com/yiisoft/yii2). + The pre-beta preview is hosted here: http://stuff.cebe.cc/yii2docs/guide_index.html [Yii Framework]: http://www.yiiframework.com/ "The Yii PHP Framework" + Installation ------------ @@ -230,6 +232,13 @@ class MyMarkdown extends \cebe\markdown\Markdown ``` +Acknowledgements +---------------- + +I'd like to thank @erusev for creating [Parsedown][] which heavily influenced this work and provided +the idea of the line based parsing approach. + + FAQ --- @@ -262,6 +271,13 @@ to using callbacks to inject functionallity into the parser. Just [open an issue][] on github, post your markdown code and describe the problem. You may also attach screenshots of the rendered HTML result to describe your problem. +### Am I free to use this? + +This library is open source and licensed under the [MIT License][]. This means that you can do whatever you want +with it as long as you mention my name and include the [license file][license]. Check the [license][] for details. + +[MIT License]: http://opensource.org/licenses/MIT + Contact ------- @@ -276,3 +292,4 @@ Feel free to contact me using [email](mailto:mail@cebe.cc) or [twitter](https:// [Yii framework 2.0]: https://github.com/yiisoft/yii2 [real parser]: http://en.wikipedia.org/wiki/Parsing#Types_of_parser [open an issue]: https://github.com/cebe/markdown/issues/new +[license]: https://github.com/cebe/markdown/blob/master/LICENSE diff --git a/bin/markdown b/bin/markdown index e5ef4be..a106cb6 100755 --- a/bin/markdown +++ b/bin/markdown @@ -1,5 +1,10 @@ #!/usr/bin/env php */ abstract class BaseMarkdownTest extends \PHPUnit_Framework_TestCase diff --git a/tests/GithubMarkdownTest.php b/tests/GithubMarkdownTest.php index 1da0008..f9dd245 100644 --- a/tests/GithubMarkdownTest.php +++ b/tests/GithubMarkdownTest.php @@ -1,9 +1,16 @@ */ class GithubMarkdownTest extends BaseMarkdownTest diff --git a/tests/MarkdownTest.php b/tests/MarkdownTest.php index 5100e77..a53a1d6 100644 --- a/tests/MarkdownTest.php +++ b/tests/MarkdownTest.php @@ -1,10 +1,16 @@ */ class MarkdownTest extends BaseMarkdownTest diff --git a/tests/profile.php b/tests/profile.php index 844fa54..7888d87 100644 --- a/tests/profile.php +++ b/tests/profile.php @@ -1,7 +1,4 @@ - */ require(__DIR__ . '/../Parser.php'); require(__DIR__ . '/../Markdown.php');