diff --git a/README.md b/README.md index 80ad87b3..59c71929 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ -# About Eclipse Che Dashboard +## About Eclipse Che -This is the first step to implement a new Eclipse Che Dashboard. +Eclipse Che is a next generation Eclipse IDE. This repository is licensed under the Eclipse Public License 2.0. Visit [Eclipse Che's Web site](https://eclipse.org/che/) for feature information or the main [Che assembly repository](https://github.com/eclipse/che) for a description of all participating repositories. + +# Eclipse Che Dashboard ## Requirements - Node.js `v10.x.x` and later. +- yarn `v1.20.0` or higher. + +**Note**: +Below you can find installation instructions +- [Node.js](https://docs.npmjs.com/getting-started/installing-node) +- [yarn](https://yarnpkg.com/lang/en/docs/install/) ## Quick start @@ -51,6 +59,24 @@ and then run the license-tool: yarn licenseCheck:run ``` +## Branding + +Default branding data for the User Dashboard is located in [branding.constant.ts](src/services/bootstrap/branding.constant.ts)#BRANDING_DEFAULT. It can be overridden without re-building the project in [product.json](/assets/branding/product.json) file which should contain only values that should overwrite default ones. + +### Configurability + +Field `"configuration.cheCliTool"` should contain the name of a CLI tool that is recommended to be used to work with Che Server from the terminal. It's the `"chectl"` by default. + +Example: + +```json +{ + "configuration": { + "cheCliTool": "chectl" + } +} +``` + ## License Che is open sourced under the Eclipse Public License 2.0.