Add short README.md file about Luigi Core (SAP#282)

stanleychh · Dec 11, 2018 · 15977ad · 15977ad
1 parent 6ac692e
commit 15977ad
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/core/public/README.md 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
@@ -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' }),