/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */

Welcome to Apache Felix Dependency Manager
==========================================

Apache Felix Dependency Manager is a versatile java API, allowing to declaratively
register, acquire, and manage dynamic OSGi services.

The bundles are documented on the website:

  http://felix.apache.org/documentation/subprojects/apache-felix-dependency-manager.html

Building and testing Apache Felix Dependency Manager
====================================================

Apache Felix Dependency Manager is built with Maven (a recent JDK, 11 or later, is required):

  mvn clean install

This builds the bundles, runs their unit tests and runs the OSGi integration tests inside a
framework (bnd-testing-maven-plugin). The framework, Gogo and Config Admin modules of this
repository, which the integration tests run on, have to be installed in the local Maven
repository first, or be available as released versions.

The modules are:

  org.apache.felix.dependencymanager             the Dependency Manager API and implementation
  org.apache.felix.dependencymanager.annotation  the annotations and the bnd plugin which processes them
  org.apache.felix.dependencymanager.runtime     loads the components declared with annotations
  org.apache.felix.dependencymanager.shell       the Gogo shell commands
  org.apache.felix.dependencymanager.lambda      the lambda based API
  org.apache.felix.dependencymanager.*.itest.*   the integration tests
  org.apache.felix.dependencymanager.samples     samples, see org.apache.felix.dependencymanager.samples/README.samples
  org.apache.felix.dependencymanager.lambda.samples
  org.apache.felix.dependencymanager.benchmark   a stress test, see org.apache.felix.dependencymanager.benchmark/README

Getting Started
===============

To start using Apache Felix Dependency Manager, please go to our website and read the
getting started guide for users:

  http://felix.apache.org/documentation/subprojects/apache-felix-dependency-manager.html

Many examples are also available from the dependency manager examples, in the org.apache.felix.dependencymanager.samples module
See org.apache.felix.dependencymanager.samples/README.samples

Many thanks for using Apache Felix Dependency Manager.

The Felix Team
