Skip to content

Commit

Permalink
Luigi client installation document (SAP#957)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandra-simeonova authored Nov 13, 2019
1 parent 9b7751c commit 415d5b8
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following guides outline Luigi Core API features and additional UI o

Luigi Client enables you to connect micro frontends to an already existing Luigi Core application.

[Installation](https://github.com/SAP/luigi/tree/master/client) shows you how to install the Luigi Client.
[Installation](luigi-client-setup.md) shows you how to install the Luigi Client.

Read the Luigi Client API documentation to learn more about the functions and parameters you can use to communicate with the core application:

Expand Down
36 changes: 36 additions & 0 deletions docs/luigi-client-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Luigi Client Installation

Luigi Client contains a library that allows your application to use all features of the Luigi framework.

## Installation

Install the client in your project using npm:
```bash
npm install @kyma-project/luigi-client
```

Import the client in places where you want to use it, depending on the environment of your choice:
```javascript
var LuigiClient = require('@kyma-project/luigi-client');
```
or
```javascript
import LuigiClient from '@kyma-project/luigi-client';
```
or, if you are not using any bundler, Luigi is also available as a global object:
```javascript
window.LuigiClient
```
You can see Luigi Client in action by running the [Angular example application](/core/examples/luigi-sample-angular).

## Usage

This section contains additional instructions and guidelines you can use to work with Luigi Client.

### Generate documentation
Validate and generate documentation using npm:

```bash
npm install
npm run docu
```

0 comments on commit 415d5b8

Please sign in to comment.