From 15977ad83e7b3d67bc185a2a02567fddbf69fc12 Mon Sep 17 00:00:00 2001 From: Barbara Date: Tue, 11 Dec 2018 13:26:28 +0100 Subject: [PATCH] Add short README.md file about Luigi Core (#282) --- core/public/README.md | 11 +++++++++++ core/webpack.config.js | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 core/public/README.md diff --git a/core/public/README.md b/core/public/README.md new file mode 100644 index 0000000000..acce887f57 --- /dev/null +++ b/core/public/README.md @@ -0,0 +1,11 @@ +# Luigi Core + +## Overview + +Luigi is a micro front-end orchestration framework written in Svelte. Use Luigi Core to implement the core application, and Luigi Client to ensure communication between the application and the micro front-end it hosts. + +For details on Luigi Core, see [this](https://github.com/kyma-project/luigi/tree/master/core) document. + +If you want to try Luigi out, see the [examples](https://github.com/kyma-project/luigi/tree/master/core/examples). + +For documentation on Luigi Core, see [Luigi documentation](https://github.com/kyma-project/luigi/tree/master/docs). diff --git a/core/webpack.config.js b/core/webpack.config.js index e84a932aa7..3e5314364c 100644 --- a/core/webpack.config.js +++ b/core/webpack.config.js @@ -87,7 +87,7 @@ module.exports = { }, plugins: [ new CleanWebpackPlugin(['public'], { - exclude: ['package.json'], + exclude: ['package.json', 'README.md'], verbose: true }), new MiniCssExtractPlugin({ filename: 'luigi.css' }),