diff --git a/README.md b/README.md index db7eb027d..0d069dcc3 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,101 @@ ![WSO2 Integration Studio](gh-docs/images/integration-studio-logo.png?raw=true) -# Devstudio-tooling-ei +[![Build Status](https://travis-ci.org/wso2/devstudio-tooling-ei.svg?branch=master)](https://travis-ci.org/wso2/devstudio-tooling-ei) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/wso2/devstudio-tooling-ei/blob/master/LICENSE) +[](https://ei-slack.wso2.com/) +[![Twitter](https://img.shields.io/twitter/follow/wso2.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=wso2) -WSO2 EI tooling provides capabilities of a complete eclipse-based development environment for the EI projects and artifact creation. -### Version -7.0.0 +# WSO2 Integration Studio + +WSO2 Integration Studio is a development environment used to design your integration scenarios and develop them. This can be used to develop services, features and artifacts as well as manage their links and dependencies through a simplified graphical editor. + +[Installation](https://ei.docs.wso2.com/en/latest/micro-integrator/develop/installing-WSO2-Integration-Studio/) | +[Documentation](https://ei.docs.wso2.com/en/latest/micro-integrator/develop/intro-integration-development/) | +[Mailing Lists](https://wso2.com/mail/) | +[Blog](https://wso2.com/blogs/thesource/) | +[Support](https://wso2.com/subscription) + + +## Outline + +- [**Why WSO2 Integration Studio?**](#Why-WSO2-Enterprise-Integrator) +- [**Features**](#Features) +- [**Distributions**](#Distributions) +- [**Installation and Run**](#Installation-and-Run) +- [**Building from Source**](#Building-from-Source) +- [**Enterprise Support**](#Enterprise-Support) +- [**Licence**](#License) + + +## Why WSO2 Integration Studio + + +## Features + +- **Graphical view**: Supports designing and development of the integration flow +- **Source view**: Represents the Synapse configuration of the integration flow +- **Connector support**: Supports working with WSO2 connectors at [WSO2 Store](https://store.wso2.com/store/assets/esbconnector/list) +- **Visual data mapping**: Maps input data formats to output data formats visually +- **Data integration support**: Supports data service and data source artifact generation +- **Business process support** : Supports BPEL workflow, human task, BPMN artifact generation +- **Docker support**: Supports Docker image generation +- **Kubernetes support**: Supports kubernetes deployment using [WSO2 EI Operator](https://github.com/wso2/k8s-ei-operator) +- **Synapse Testing Framework**: Allows testing the integration scenario with the Synapse Testing Framework +- **Debugger**: Allows debugging the mediation flow +- **WSO2 Server support**: Supports adding WSO2 ESB/EI servers as remote servers and WSO2 MI as the embedded server +- **Embedded JDK**: Contains with an embedded JDK +- **Embedded WSO2 Micro Integrator**: Contains with an embedded WSO2 Micro Integrator for testing the integration flow + + +## Distributions +WSO2 Integration Studio maintains distributions can be downloaded, [here](https://wso2.com/integration/integration-studio/). + +All open issues pertaining to WSO2 Integration Studio are reported at the following location: +[known issues](https://github.com/wso2/devstudio-tooling-ei/issues) + + +## Installation and Run +1. Download the [distribution](https://wso2.com/integration/integration-studio/) for your operating system. +2. Extract the downloaded file to get the **IntegrationStudio** application. If you are a MacOS user, be sure to add it to the **Applications** directory. +3. Run the **IntegrationStudio** application to start the tool. + + +### Building from Source + +If you intend to build the project from the source you can do that with or without building the dependent projects. +Here is an outline how the dependent project are structured. If you build with dependencies, you need to do it from +bottom to top in the hierarchy. + +Repositories referred above + +- [devstudio-tooling-ei](https://github.com/wso2/devstudio-tooling-ei/): contains Integration Studio packaging. +- [devstudio-tooling-bps](https://github.com/wso2/devstudio-tooling-bps): contains features related to business processes. +- [devstudio-tooling-dss](https://github.com/wso2/devstudio-tooling-dss/): contains features related to data services. +- [devstudio-tooling-esb](https://github.com/wso2/devstudio-tooling-esb/): mediation features related to WSO2 ESB are developed in this repository. +- [devstudio-tooling-platform](https://github.com/wso2/devstudio-tooling-platform/): implementation common WSO2 features for the Eclipse platform. +- [developer-studio](https://github.com/wso2/developer-studio/): implements Eclipse platform customizations for Integration Studio. + +## Enterprise Support + +Enterprise support for WSO2 Integration Studio is provided by WSO2. Learn more [here](https://wso2.com/subscription). + +## License -### How to Build -This requires maven installed in your system. Run these commands to clone the repo and build it. -```sh -$ git clone [git-repo-url] -$ cd devstudio-tooling-ei -$ mvn clean install ``` -### How to Install +Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. + +WSO2 Inc. licenses this file to you under the Apache License, +Version 2.0 (the "License"); you may not use this file except +in compliance with the License. +You may obtain a copy of the License at -After a successful build you will get installable zips (P2 Repos) of the plugin inside repository -> composite and repository -> main . If you have a WSO2 Developer Studio distribution you should install repository -> main and if you have a General eclipse distribution you should choose repository -> composite . + http://www.apache.org/licenses/LICENSE-2.0 -In eclipse go to help -> Install new software and select the respective path (repository -> composite -> built zip or repository -> main -> built zip) to the built zip file. And install required features. +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +``` \ No newline at end of file