Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add short README.md file about Luigi Core #282

Merged
merged 10 commits into from
Dec 11, 2018
11 changes: 11 additions & 0 deletions core/public/README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion core/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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' }),
Expand Down