diff --git a/README.md b/README.md index d0ab3f37..00ec599e 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,13 @@ npm install -g @aeternity/aeproject ## Documentation -- [Quick Start](docs/index.md) -- [Project Initialization](docs/cli/init.md) -- [Local Environment](docs/cli/env.md) -- [Unit Testing](docs/cli/test.md) -- [AEproject Library](docs/lib.md) -- [Migration from 3.x.x to 4.x.x](docs/migration-from-3.x.x-to-4.x.x.md) +* [Quick Start](docs/index.md) +* [Project Initialization](docs/cli/init.md) +* [Local Environment](docs/cli/env.md) +* [Unit Testing](docs/cli/test.md) +* [AEproject Library](docs/lib.md) +* [Migration from 3.x.x to 4.x.x](docs/migration-from-3.x.x-to-4.x.x.md) +* [Migration from 4.x.x to 5.x.x](docs/migration-from-4.x.x-to-5.x.x.md) - [Upcoming Version Support](docs/next-support.md) ## Release Process diff --git a/docs/cli/init.md b/docs/cli/init.md index 5e70bedd..f704b3de 100644 --- a/docs/cli/init.md +++ b/docs/cli/init.md @@ -10,7 +10,7 @@ Creates a new project structure with a few folders in which the developer can cr ## Update existing project -For upgrade from old AEproject versions check out [Migration from 3.x.x to 4.x.x](../migration-from-3.x.x-to-4.x.x.md). +For upgrade from old AEproject versions check out [Migration from 3.x.x to 4.x.x](../migration-from-3.x.x-to-4.x.x.md) and [Migration from 4.x.x to 5.x.x](../migration-from-4.x.x-to-5.x.x.md). ```text aeproject init --update diff --git a/docs/migration-from-4.x.x-to-5.x.x.md b/docs/migration-from-4.x.x-to-5.x.x.md new file mode 100644 index 00000000..bb1efa2f --- /dev/null +++ b/docs/migration-from-4.x.x-to-5.x.x.md @@ -0,0 +1,14 @@ +# Migration from 4.x.x to 5.x.x + +## Changes +**AEproject** `v5.0.0` underwent some minor but breaking changes. + +Install the new AEproject version +``` +npm install -g @aeternity/aeproject +``` + +### Removed from libs +Following utils have been removed and cannot be used anymore: + +- `utils.getFilesystem()` discontinued, as it is now natively available in the sdk via import, e.g. `const { getFileSystem } = require("@aeternity/aepp-sdk");` diff --git a/mkdocs.yml b/mkdocs.yml index 92c0a371..0beb3f45 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -47,4 +47,5 @@ nav: - cli/test.md - lib.md - migration-from-3.x.x-to-4.x.x.md + - migration-from-4.x.x-to-5.x.x.md - next-support.md