------
 Introduction
 ------
 Mark Hobson
 <markh@apache.org>
 ------
 2013-07-24
 ------

 ~~ 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.

 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/doxia/references/apt-format.html

${project.name}

 Maven Runtime allows introspection of Maven project metadata at runtime.  Basic artifact information or full Maven 
 project metadata can be obtained for all projects within a given class loader, optionally sorted into dependency order,
 and also for a given class within a project.  These techniques can used by tools wishing to utilize Maven metadata at 
 runtime.
 
 Maven metadata is obtained from one of the two
 {{{http://maven.apache.org/shared/maven-archiver/index.html#class_archive}Maven descriptor files}} automatically 
 generated by the {{{http://maven.apache.org/shared/maven-archiver/}Maven Archiver}}: <<<pom.properties>>> and 
 <<<pom.xml>>> in the <<<META-INF/<groupId>/<artifactId>>>> directory.  The project properties file provides basic 
 artifact information (group id, artifact id and version), whereas the project XML file provides full Maven metadata 
 contained within the project's POM.

 Note that since Maven Runtime uses resources generated by the Maven Archiver, it can only successfully introspect the
 runtime environment when executed from within the packaged project, as opposed to running within an IDE.
 
 <<Note: Maven Runtime requires at least Java 5.>>
 
* Usage

 Instructions on how to use Maven Runtime can be found on the {{{./usage.html}usage page}}.

* Examples

 To provide you with better understanding of some usages of Maven Runtime, you can take a look into the following
 examples:

 * {{{./examples/introspecting-a-url.html}Introspecting a URL}}
 
 * {{{./examples/introspecting-a-class.html}Introspecting a class}}

 * {{{./examples/introspecting-a-class-loader.html}Introspecting a class loader}}