Changelog [ci skip]

Author: aarondfrancis

CHANGELOG.md

@@ -2,8 +2,14 @@
 
 ## Unreleased
 
+## 0.5.0 - 2021-09-06
+
+### Changed
+- Deprecated `\Torchlight\Commonmark\TorchlightExtension` in favor of the versioned `\Torchlight\Commonmark\V1\TorchlightExtension` and `\Torchlight\Commonmark\V2\TorchlightExtension` extensions 
+
 ### Added
-- You can now load files from markdown by using the `<<< file.php` convention.
+- You can now load files from markdown by using the `<<< path/to/file.php` convention.
+- Added support for CommonMark V2
 
 ## 0.4.1 - 2021-08-02
 

README.md

@@ -2,16 +2,19 @@
 
 [![Tests](https://github.com/torchlight-api/torchlight-commonmark-php/actions/workflows/tests.yml/badge.svg)](https://github.com/torchlight-api/torchlight-commonmark-php/actions/workflows/tests.yml) [![Latest Stable Version](https://poser.pugx.org/torchlight/torchlight-commonmark/v)](//packagist.org/packages/torchlight/torchlight-commonmark) [![Total Downloads](https://poser.pugx.org/torchlight/torchlight-commonmark/downloads)](//packagist.org/packages/torchlight/torchlight-commonmark) [![License](https://poser.pugx.org/torchlight/torchlight-commonmark/license)](//packagist.org/packages/torchlight/torchlight-commonmark)
 
+> 📚 The full docs can be found at [torchlight.dev/docs/clients/commonmark-php](https://torchlight.dev/docs/clients/commonmark-php).
 
 A [Torchlight](https://torchlight.dev) syntax highlighting extension for the PHP League's [Commonmark Markdown Parser](https://commonmark.thephpleague.com/) in a Laravel application.
 
+Supports both CommonMark version 1 and version 2.
+
 Torchlight is a VS Code-compatible syntax highlighter that requires no JavaScript, supports every language, every VS Code theme, line highlighting, git diffing, and more.
 
 ## Installation
 
 To install, require the package from composer:
 
-```
+```shell
 composer require torchlight/torchlight-commonmark
 ```
 
@@ -31,8 +34,14 @@ If you are using Graham Campbell's [Laravel Markdown](https://github.com/GrahamC
 If you aren't using the Laravel Markdown package, you can add the extension manually:
 
 ```php
+// CommonMark V1
 $environment = Environment::createCommonMarkEnvironment();
 $environment->addExtension(new TorchlightExtension);
+
+// CommonMark V2
+$environment = new Environment();
+$environment->addExtension(new CommonMarkCoreExtension);
+$environment->addExtension(new TorchlightExtension);
 ```
 
 *That's all you need to do! All of your code fences will now be highlighted via Torchlight.*
@@ -41,7 +50,7 @@ $environment->addExtension(new TorchlightExtension);
 
 Once the package is downloaded, you can run the following command to publish your configuration file:
 
-```
+```shell
 php artisan torchlight:install
 ```