Update sample README

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@1150291 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 21 insertions, 29 deletions

diff --git a/sca-java-2.x/trunk/samples/getting-started/helloworld-withdeps/README b/sca-java-2.x/trunk/samples/getting-started/helloworld-withdeps/README
index fc306caa34..a5d5272d8f 100644
--- a/sca-java-2.x/trunk/samples/getting-started/helloworld-withdeps/README
+++ b/sca-java-2.x/trunk/samples/getting-started/helloworld-withdeps/README
@@ -1,43 +1,35 @@
-Tuscany - Getting Started - Helloworld Sample

----------------------------------------------

+Tuscany - Getting Started - Helloworld With Dependencies Sample

+---------------------------------------------------------------

 

-This sample demonstrates a simple helloworld style SCA application and how to run that with Tuscany.

+This sample extends the helloworld sample to show how to use ZIP format contributions which include dependencys jar which are made available on the contribution classpath. To demonstrate this the Helloworld service is updated to use a Apache Commons Lang 3.0 utility to capatalize the first letter of the name.

 

-See the README in the top-level samples folder for general information on the Tuscany samples.

+The changes to the helloworld sample are:

+- update sample.HelloworldImpl class is updated to use the Apache Commons Lang 3.0 WordUtils utility 

+- the Maven build is updated to use the Assembly plugin to create a ZIP archive of the contrubution which includes the dependency jars

 

-This project creates an SCA contribution with a deployable composite named helloworld.composite.

-The composite defines an SCA component, HelloworldComponent, which provides a Helloworld service, 

-the component is implemented by a Java class. 

+Presently the Tuscany Shell does not work "as is" to run this sample with "mvn tuscany:run". Instead you need to do the following in the helloworld-withdeps directory:

 

-You can use the contribution by starting the composite in the Tuscany Shell. To do that run the 

-following command in the helloworld folder:

+- build the ZIP contribution

+    

+   mvn clean install

 

-   mvn tuscany:run 

+- start the Tuscany Shell

 

-Alternatively, the Tuscany Shell can be started with the scripts in the Tuscany binary distribution 

-bin folder. To do that run the following command at the root of a Tuscany binary distribution:

+   mvn tuscany:shell

 

-   bin\tuscany.bat samples\getting-started\helloworld

+- install the sample contribution

 

-Once the Shell has been started with one of those methods you can use Shell commands to explore

-the SCA domain, for example, use the "installed" command to get the status of installed contributions, 

-"services" to see the available component services, and you may test calling the helloworld service by 

-using the "invoke" command:

+  install target\helloworld-withdeps-2.0-SNAPSHOT.zip

 

-   invoke HelloworldComponent sayHello yourName

+- start the SCA composite

+

+  start helloworld-withdeps META-INF/helloworld.composite

 

----

- 

-This sample was created by the Tuscany contribution-jar Maven archetype. You can use that archetype to 

-create your own SCA contribution projects by running the following Maven command:

+And then as with the original helloworld sample you may test the service by using the Shell "invoke" command:

 

-   mvn archetype:generate -DarchetypeCatalog=http://tuscany.apache.org

+   invoke HelloworldComponent sayHello yourName

 

-then at the prompt select 1 to choose the contribution-jar archetype and then answer the questions. 

-This project used the following answers:

+which should return a hello text with the name capatilized:

 

-   Define value for property 'groupId': : org.apache.tuscany.sca.samples

-   Define value for property 'artifactId': : helloworld-contribution

-   Define value for property 'version': 1.0-SNAPSHOT: 2.0-SNAPSHOT

-   Define value for property 'package': org.apache.tuscany.sca.samples: sample  

+   Hello YourName