From 486f91e3a77ea866d029f5f957c314f78896ccda Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20=C5=BD=C3=A1dn=C3=ADk?= <kubouch@gmail.com>
Date: Mon, 13 Dec 2021 12:14:03 +0200
Subject: [PATCH] Start documenting breaking changes

---
 docs/Beaking_Changes.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 docs/Beaking_Changes.md

diff --git a/docs/Beaking_Changes.md b/docs/Beaking_Changes.md
new file mode 100644
index 000000000..dd253c287
--- /dev/null
+++ b/docs/Beaking_Changes.md
@@ -0,0 +1,15 @@
+# Beaking Changes
+
+This file attempts to list all breaking changes that came with the new engine update.
+
+## Variable Name Changes
+
+* `$nu.home-dir` is now called `$nu.home-path`
+* `$nu.temp-dir` is now called `$nu.temp-path`
+* All config is now contained within `$config` which can be initialized by `config.nu`. There is no `config.toml` anymore.
+
+## `main` Command in Scripts
+
+If the script contains `main` it will be ran after all the script is executed.
+It also accepts arguments from the command line.
+You can run it like this: `nu foo.nu arg1 --flag` of if the script contains a hashbang line (`#!/usr/bin/env nu`): `./foo.nu arg1 --flag`.