[14/50] [abbrv] storm git commit: add basic instructions for examples

[pt...@apache.org]

add basic instructions for examples


Project: http://git-wip-us.apache.org/repos/asf/storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/8b690e63
Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/8b690e63
Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/8b690e63

Branch: refs/heads/master
Commit: 8b690e63954b14aa8f079f904d42d2f4beb34cc6
Parents: 2e44c9e
Author: P. Taylor Goetz <pt...@gmail.com>
Authored: Thu Apr 2 12:19:13 2015 -0400
Committer: P. Taylor Goetz <pt...@gmail.com>
Committed: Thu Apr 2 12:19:13 2015 -0400

----------------------------------------------------------------------
 flux-examples/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/storm/blob/8b690e63/flux-examples/README.md
----------------------------------------------------------------------
diff --git a/flux-examples/README.md b/flux-examples/README.md
new file mode 100644
index 0000000..2f107e7
--- /dev/null
+++ b/flux-examples/README.md
@@ -0,0 +1,28 @@
+# Flux Examples
+A collection of examples illustrating various capabilities.
+
+## Building From Source and Running
+
+Checkout the projects source and perform a top level Maven build (i.e. from the `flux` directory):
+
+```bash
+git clone https://github.com/ptgoetz/flux.git
+cd flux
+mvn install
+```
+
+This will create a shaded (i.e. "fat" or "uber") jar in the `flux-examples/target` directory that can run/deployed with
+the `storm` command:
+
+```bash
+cd flux-examples
+storm jar ./target/flux-examples-0.2.3-SNAPSHOT.jar org.apache.storm.flux.Flux --local ./src/main/resources/simple_wordcount.yaml
+```
+
+The example YAML files are also packaged in the examples jar, so they can also be referenced with Flux's `--resource`
+command line switch:
+
+```bash
+storm jar ./target/flux-examples-0.2.3-SNAPSHOT.jar org.apache.storm.flux.Flux --local --resource /sime_wordcount.yaml
+```
+