Skip to content

Commit

Permalink
updating the readme file
Browse files Browse the repository at this point in the history
Signed-off-by: mflinn <mflinn@redhat.com>
  • Loading branch information
MelissaFlinn authored and apupier committed Apr 4, 2019
1 parent 10f4a20 commit ebe3789
Showing 1 changed file with 30 additions and 13 deletions.
43 changes: 30 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,43 @@
[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)]()
[![Gitter](https://img.shields.io/gitter/room/camel-tooling/Lobby.js.svg)](https://gitter.im/camel-tooling/Lobby)

# Apache Camel for Eclipse

This is a preview release of the Eclipse plugin that adds [Apache Camel](http://camel.apache.org/) language support for XML DSL and Java DSL code.

# Features

When using the Generic Text editor, completion and documentation on hover are supported. See [here](https://github.com/camel-tooling/camel-language-server/blob/master/README.md#features) for details.
After you add this extension to your Eclipse IDE installation, when you use the generic Eclipse text editor, you can access the following Apache Camel language service features for Apache Camel URIs (both XML DSL and Java DSL):

When using XML or Java editor, only the completion is provided.
* Auto-completion for Camel components, attributes, and the list of attribute values

* Quick reference documentation when you hover the cursor over a Camel component

When you use the XML or Java editor, only the auto-completion feature is provided.

For detailed information about Apache Camel supported features, see the [Language Server GitHub page](https://github.com/camel-tooling/camel-language-server#features).

# Before you begin

* Install the [Eclipse IDE](https://www.eclipse.org/ide/).

Optionally, you can install this plugin on top of an Eclipse IDE installation with Red Hat CodeReady Studio and [Fuse Tooling](https://tools.jboss.org/features/fusetools.html). This **Apache Camel for Eclipse** plugin provides even more help for Fuse development.

* Install the [Eclipse Marketplace client](https://www.eclipse.org/mpc/). In Eclipse, select **Help > Install New Software** and then type **MPC**. Follow the prompts in the installation wizard.

# How to Install

* Install Eclipse
* Drag the button to your running Eclipse
To install this **Apache Camel for Eclipse** plugin:

* Open your Eclipse IDE installation.
* Drag this button [![Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client](https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png)](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=4038733 "Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client") to your running Eclipse workspace.

* Wait until Eclipse completes the installation of the plugin.

* In the popup window that appears when the plugin installation completes, click **Confirm**.
* Accept the license, if asked.
* Click **Finish**.
* Click **Install Anyway**.
* Click **Restart Now**.

[![Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client](https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png)](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=4038733 "Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client")
* Click Confirm
* Accept license if asked
* Click Finish
* Wait...
* Click "Install Anyway"
* Click "Restart Now"
* Enjoy!

tips: you can install it on top of [Fuse Tooling](https://tools.jboss.org/features/fusetools.html) which will provide even more help for development.

0 comments on commit ebe3789

Please sign in to comment.