From fbbc7282c6604f7efb6d3d08542dbd24f36aa1d3 Mon Sep 17 00:00:00 2001 From: Leo Horie Date: Fri, 2 Dec 2016 21:59:43 -0500 Subject: [PATCH] rename migration guide --- docs/{v1.x-migration.md => change-log.md} | 10 +++++++++- docs/guides.md | 10 +++++----- 2 files changed, 14 insertions(+), 6 deletions(-) rename docs/{v1.x-migration.md => change-log.md} (98%) diff --git a/docs/v1.x-migration.md b/docs/change-log.md similarity index 98% rename from docs/v1.x-migration.md rename to docs/change-log.md index e67efcb5..2698ad9d 100644 --- a/docs/v1.x-migration.md +++ b/docs/change-log.md @@ -1,7 +1,15 @@ -# Migrating from `v0.2.x` to `v1.x` +# Change log + +- [Migrating from v0.2.x](#migrating-from-v02x) + +--- + +### Migrating from `v0.2.x` `v1.x` is largely API-compatible with `v0.2.x`, but there are some breaking changes. +If you are migrating, consider using the [mithril-codemods](https://www.npmjs.com/package/mithril-codemods) tool to help automate the most straightforward migrations. + - [`m.prop` removed](#mprop-removed) - [`m.component` removed](#mcomponent-removed) - [`config` function](#config-function) diff --git a/docs/guides.md b/docs/guides.md index f7a7f0b9..7b77745e 100644 --- a/docs/guides.md +++ b/docs/guides.md @@ -9,8 +9,8 @@ - [Components](components.md) - [Lifecycle methods](lifecycle-methods.md) - [Keys](keys.md) -- Migration - - [Migrating from 0.2.x](migration.md) -- Meta - - [Chat room](https://gitter.im/lhorie/mithril.js) - - [Credits](credits.md) \ No newline at end of file +- Social + - [Community chat](https://gitter.im/lhorie/mithril.js) + - [Credits](credits.md) +- Misc + - [Change log/Migration](change-log.md)