Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
scottslewis authored Feb 3, 2025
1 parent 054c0e3 commit 2643a05
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,34 @@ Update Site as Zip: [org.eclipse.ecf.sdk_3.15.5.v20250124-1843.zip](https://www

There are now [Oomph](https://projects.eclipse.org/projects/tools.oomph) Setups that will automatically install and configure Eclipse, Bndtools 7.1 and ECF 3.15.5 [see here](https://github.com/bndtools/bndtools.p2.repo/tree/master/setup/ecf)

### Features for Bndtools-based [OSGi Remote Services](https://docs.osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html) Development

#### Workspace, Project, and Bndrun Templates

Bndtools Workspace Template for Remote Services Development here: [https://github.com/ECF/bndtools.workspace](https://github.com/ECF/bndtools.workspace). This workspace template contains multiple project templates for creating Remote Service API, Impl, and Consumer projects via the New->Bnd OSGi Project wizard:

![image](https://github.com/user-attachments/assets/1c775de3-4970-4202-865f-1ac3ba0b0f32)

#### Wizards for creating api, impl, consumer Remote Services projects via a single wizard

![image](https://github.com/user-attachments/assets/674fb4ba-8f67-42fb-8664-341d45fce17a)

#### Eclipse Views for Endpoint Discovery and [Remote Service Admin Manager](https://docs.osgi.org/specification/osgi.cmpn/8.0.0/service.remoteserviceadmin.html)

![image](https://github.com/user-attachments/assets/acd0e785-06db-4136-9b97-9a0ea944a062)

#### Wizard and Template-Created Bndrun files, to immediately run/debug wizard-generated remote services

![image](https://github.com/user-attachments/assets/97f85c7f-78e6-4016-ac8c-bbe014bd9446)

### Download/Install into [Apache Karaf 4.4+](https://karaf.apache.org/)
https://download.eclipse.org/rt/ecf/latest/karaf-features.xml

For Install into Karaf runtime, [here is a top-level Karaf Features file](https://download.eclipse.org/rt/ecf/latest/karaf-features.xml)

## Key ECF APIs

### OSGi Remote Services
ECF provides a fully-compliant and multi-provider implementation of the [OSGi Remote Services](https://docs.osgi.org/specification/osgi.cmpn/7.0.0/service.remoteservices.html) and [Remote Services Admin/RSA](https://docs.osgi.org/specification/osgi.cmpn/7.0.0/service.remoteserviceadmin.html). A number of providers are available in this repo, but there are also many providers available at the [ECF github organization](https://github.com/ECF).
ECF provides a fully-compliant and multi-provider implementation of the [OSGi Remote Services](https://docs.osgi.org/specification/osgi.cmpn/8.0.0/service.remoteservices.html) and [Remote Services Admin/RSA](https://docs.osgi.org/specification/osgi.cmpn/8.0.0/service.remoteserviceadmin.html). A number of providers are available in this repo, but there are also many providers available at the [ECF github organization](https://github.com/ECF).

ECF is the OSGi R8 RS/RSA implementation in the [OSGi Test Compatibilty Kit (TCK)](https://github.com/osgi/osgi)

Expand All @@ -35,13 +56,13 @@ ECF filetransfer is used by the [Eclipse IDE](https://github.com/eclipse-platfor
ECF has an [organization with a number of other repos](https://github.com/ECF) containing Remote Services distribution and discovery providers (e.g. grpc, etcd discovery, hazelcast, JMS, JGroups, xmlrpc-based distribution providers, examples, others). Most of these repos provide distribution or discovery providers that depend upon the core remote services/RSA implementation provided by this repo.

## Wiki
See the [ECF Wiki](https://wiki.eclipse.org/Eclipse_Communication_Framework_Project) for examples, tutorials, other documentation, as well as plans for future releases.
See the [ECF Wiki](https://wiki.eclipse.org/Eclipse_Communication_Framework_Project) for examples, tutorials, Karaf install documentation, other documentation.

To contribute or find out what's going on right now, please join the [ecf-dev mailing list](https://accounts.eclipse.org/mailing-list/ecf-dev) or contact project lead Scott Lewis at github username: scottslewis
To contribute or find out what's going on right now, please join the [ecf-dev mailing list](https://accounts.eclipse.org/mailing-list/ecf-dev) or contact project lead Scott Lewis at github email: scottslewis at gmail.com

## Services, Training, and Support
For Remote Services training, support, or custom OSGi or Eclipse development please contact scottslewis at gmail.com via email or post on the [ecf-dev mailing list](https://accounts.eclipse.org/mailing-list/ecf-dev)

### Contributing to ECF
Contributions are always welcome!
Contributions are always welcome! For 20 years ECF has been innovating via community contributions.
See [CONTRIBUTING.md](CONTRIBUTING.md)

0 comments on commit 2643a05

Please sign in to comment.