forked from SAP/luigi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Luigi client installation document (SAP#957)
- Loading branch information
1 parent
9b7751c
commit 415d5b8
Showing
2 changed files
with
37 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |