add readme
Project: http://git-wip-us.apache.org/repos/asf/aries-jax-rs-whiteboard/repo Commit: http://git-wip-us.apache.org/repos/asf/aries-jax-rs-whiteboard/commit/4b36003c Tree: http://git-wip-us.apache.org/repos/asf/aries-jax-rs-whiteboard/tree/4b36003c Diff: http://git-wip-us.apache.org/repos/asf/aries-jax-rs-whiteboard/diff/4b36003c Branch: refs/heads/master Commit: 4b36003c1e65e355de9d55f96556280caa81d8f1 Parents: 3af0157 Author: Raymond Auge <[email protected]> Authored: Fri Oct 28 11:49:41 2016 +0200 Committer: Raymond Auge <[email protected]> Committed: Fri Oct 28 11:49:41 2016 +0200 ---------------------------------------------------------------------- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/aries-jax-rs-whiteboard/blob/4b36003c/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a7519a --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +## JAX-RS Whiteboard + +This is an implementation of a JAX-RS Services whiteboard [OSGi RFC-217](https://github.com/osgi/design/tree/master/rfcs/rfc0217). + +## Building + +Execute the usual maven task `mvn package`. + +## Running the Example + +This is a two step process. + +### Create the executable jar + +In the bndrun subdirectory, execute the task `mvn bnd-export:export` + +**Note:** There's an occasional NPE occuring during the resolve operation. If you should encounter this, please try again. + +### Run the exported jar + +Once exported, the bndrun directory should contain a file `org.apache.aries.jax-rs.example.jar`. + +Execute the following command + +``` +java -jar org.apache.aries.jax-rs.example.jar +``` \ No newline at end of file
