[maven-release-plugin] copy for tag cxf-dosgi-ri-1.0
[cxf-dosgi.git] / distribution / multi-bundle / src / main / release / README
1 Welcome to the Apache CXF Distributed OSGi DSW Reference Implementation
2 =======================================================================
3
4
5 The dOSGi subproject of Apache CXF provides the Reference Implementation
6 of the Distribution Software (DSW) component of the Distributed OSGi
7 Specification[1].
8
9
10 This release is provided for your convenience in three different 
11 distribution formats:
12
13 1. Multi-bundle distro: cxf-dosgi-ri-multibundle-distribution-1.0.{tar.gaz|zip}
14
15 Contains the dOSGi implementation and all 3rd party dependencies as 
16 separate bundles within an archive. The current distribution is an
17 instance of this type. The easiest way to get started is to explode
18 this archive into your Felix or Equinox installation tree. Then
19 append the contents of the felix.config.properties.append or
20 equinox.config.ini.append snippets found in the conf directory to 
21 your felix.config.properties or equinox.config.ini. This will cause
22 all the required bundles to be loaded on start-up.
23
24
25 2. Single-bundle distro: cxf-dosgi-ri-singlebundle-distribution-1.0.jar
26
27 Contains the dOSGi implementation and all 3rd party dependencies wrapped
28 in a single OSGi bundle so as to allow direct installation in your favourite 
29 OSGi container in one fell swoop.
30
31         
32 3. Source distro: cxf-dosgi-ri-source-distribution-1.1-SNAPSHOT.{tar.gz|zip}
33
34 Contains the entire source tree for dOSGi.
35
36
37 The best starting point for using dOSGi is the Getting Started Guide[2].
38
39 Also note the very detailed walk-through of the greeter demo[3].
40
41 If you need more help, or want to provide any feedback, please feel free 
42 to drop us a note on the CXF dev or users list[4].
43  
44 If you trip over any problems with dOSGi, don't hesitate to submit an issue
45 to the CXF JIRA[5] with the component set to "Distributed-OSGi".
46
47
48 Thanks for using dOSGi!
49
50 Regards,
51 The CXF dOSGi team.
52
53
54 [1] See RFC 119 in http://www.osgi.org/download/osgi-4.2-early-draft3.pdf
55 [2] http://cxf.apache.org/distributed-osgi.html#DistributedOSGi-GettingStarted
56 [3] http://cxf.apache.org/distributed-osgi-greeter-demo-walkthrough.htm
57 [4] http://cxf.apache.org/mailing-lists.html
58 [5] https://issues.apache.org/jira/browse/CXF