diff --git a/UPGRADING.md b/UPGRADING.md index 5afdd6fc..f14097e7 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -7,8 +7,13 @@ of `Phoenix.View` in the core SDK, the way the templates are created, and the co generated by Torch have changed significantly. There is no automatic upgrade path for existing files that were generated with previous versions of Torch. -You can either continue to use Torch v4, or manually update your existing Torch templates to the new unified -function component style provided by `Phoenix.Component`. +If you encounter issues using Torch v5 with existing templates, you can either continue to use Torch v4, +or manually update your existing Torch templates to the new unified function component style +provided by `Torch.Component`. + +Templates that were generated with Torch v4 _should_ still funtion, if you manaully included `:phoenix_view` +in your projects mix dependencies, but your results may vary. For templates generated with Torch v4, you +would also need to make the manual updates described below in the "Torch v3 to Torch v4" section. #### Slime support dropped diff --git a/mix.exs b/mix.exs index 0a3cabf1..6a98425e 100644 --- a/mix.exs +++ b/mix.exs @@ -61,7 +61,7 @@ defmodule Torch.MixProject do [ maintainers: ["MojoTech"], licenses: ["MIT"], - files: ~w(lib priv mix.exs README.md LICENSE CHANGELOG.md CODE_OF_CONDUCT.md), + files: ~w(lib priv mix.exs README.md LICENSE CHANGELOG.md CODE_OF_CONDUCT.md UPGRADING.md), links: %{ "Github" => @source_url } @@ -74,7 +74,8 @@ defmodule Torch.MixProject do "CHANGELOG.md": [title: "Changelog"], "CODE_OF_CONDUCT.md": [title: "Code of Conduct"], LICENSE: [title: "License"], - "README.md": [title: "Overview"] + "README.md": [title: "Overview"], + "UPGRADING.md": [title: "Upgrading"] ], main: "readme", source_ref: "v#{@version}",