Merge pull request #37 from ergebnis/feature/markdown

Enhancement: Use Markdown for license
ergebnis · Jan 19, 2020 · 17b867c · 17b867c
2 parents 4bf75da + 67d56e4
commit 17b867c
Show file tree

Hide file tree

Showing 34 changed files with 53 additions and 37 deletions.
diff --git a/.php_cs b/.php_cs
@@ -6,7 +6,7 @@ declare(strict_types=1);
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */
@@ -22,8 +22,8 @@ $range = License\Range::since(
 $holder = License\Holder::fromString('Andreas Möller');
 
 $file = License\File::create(
-    __DIR__ . '/LICENSE',
-    License\Template::fromFile(__DIR__ . '/resource/license/MIT.txt'),
+    __DIR__ . '/LICENSE.md',
+    License\Template::fromFile(__DIR__ . '/resource/license/MIT.md'),
     $range,
     $holder
 );

diff --git a/LICENSE → LICENSE.md b/LICENSE → LICENSE.md
@@ -1,16 +1,16 @@
-The MIT License (MIT)
+# The MIT License (MIT)
 
 Copyright (c) 2020 Andreas Möller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+documentation files (the _Software_), to deal in the Software without restriction, including without limitation the
 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
 persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+THE SOFTWARE IS PROVIDED **AS IS**, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -35,4 +35,4 @@ Please have a look at [`CODE_OF_CONDUCT.md`](https://github.com/ergebnis/.github
 
 ## License
 
-This package is licensed using the MIT License.
+This package is licensed using the [MIT License](LICENSE.md).
diff --git a/resource/license/MIT.md b/resource/license/MIT.md
@@ -0,0 +1,16 @@
+# The MIT License (MIT)
+
+Copyright (c) <range> <holder>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the _Software_), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED **AS IS**, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Exception/InvalidFile.php b/src/Exception/InvalidFile.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Exception/InvalidHolder.php b/src/Exception/InvalidHolder.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Exception/InvalidRange.php b/src/Exception/InvalidRange.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Exception/InvalidReplacements.php b/src/Exception/InvalidReplacements.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Exception/InvalidUrl.php b/src/Exception/InvalidUrl.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Exception/InvalidYear.php b/src/Exception/InvalidYear.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/File.php b/src/File.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Header.php b/src/Header.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Holder.php b/src/Holder.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Period.php b/src/Period.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Range.php b/src/Range.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Template.php b/src/Template.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Url.php b/src/Url.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/src/Year.php b/src/Year.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/AutoReview/SrcCodeTest.php b/test/AutoReview/SrcCodeTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/Exception/InvalidFileTest.php b/test/Unit/Exception/InvalidFileTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/Exception/InvalidHolderTest.php b/test/Unit/Exception/InvalidHolderTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/Exception/InvalidRangeTest.php b/test/Unit/Exception/InvalidRangeTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/Exception/InvalidReplacementsTest.php b/test/Unit/Exception/InvalidReplacementsTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/Exception/InvalidUrlTest.php b/test/Unit/Exception/InvalidUrlTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/Exception/InvalidYearTest.php b/test/Unit/Exception/InvalidYearTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/FileTest.php b/test/Unit/FileTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/HeaderTest.php b/test/Unit/HeaderTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/HolderTest.php b/test/Unit/HolderTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/RangeTest.php b/test/Unit/RangeTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/TemplateTest.php b/test/Unit/TemplateTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/UrlTest.php b/test/Unit/UrlTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Unit/YearTest.php b/test/Unit/YearTest.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */

diff --git a/test/Util/DataProvider/Text.php b/test/Util/DataProvider/Text.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2020 Andreas Möller
  *
  * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
+ * the LICENSE.md file that was distributed with this source code.
  *
  * @see https://github.com/ergebnis/license
  */
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,4 +35,4 @@ Please have a look at [`CODE_OF_CONDUCT.md`](https://github.com/ergebnis/.github

		## License

		This package is licensed using the MIT License.
		This package is licensed using the [MIT License](LICENSE.md).