svn commit: r1594571 - in /jackrabbit/oak/trunk/oak-doc/src/site: markdown/use_getting_started.md site.xml

[md...@apache.org]

Author: mduerig
Date: Wed May 14 13:08:18 2014
New Revision: 1594571

URL: http://svn.apache.org/r1594571
Log:
OAK-301: Document Oak
- Getting started

Modified:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md
    jackrabbit/oak/trunk/oak-doc/src/site/site.xml

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md?rev=1594571&r1=1594570&r2=1594571&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md Wed May 14 13:08:18 2014
@@ -15,8 +15,30 @@
    limitations under the License.
   -->
 
-TODO: Document how to use Oak:
+# Runnable jar
+
+Oak comes with a [runnable jar](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-run/README.md),
+which contains everything you need for a simple Oak installation.
+
+
+# Using Oak in your project
+
+To use Oak in your project simply add a dependency to `org.apache.jackrabbit:oak-jcr:1.0.0` and to
+`javax.jcr:jcr:2.0`:
+
+    <dependency>
+      <groupId>org.apache.jackrabbit</groupId>
+      <artifactId>oak-jcr</artifactId>
+      <version>1.0.0</version>
+    </dependency>
+    <dependency>
+      <groupId>javax.jcr</groupId>
+      <artifactId>jcr</artifactId>
+      <version>2.0</version>
+    </dependency>
+
+Oak has simple mechanisms for constructing and configuring content repositories
+for use in embedded deployments and test cases:
 
-* Required (Maven) Dependencies
 * [Repository construction](construct.html)
-* [Oak runnable jar](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-run/README.md)
+* [Configuring Oak](osgi_config.html)
\ No newline at end of file

Modified: jackrabbit/oak/trunk/oak-doc/src/site/site.xml
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/site.xml?rev=1594571&r1=1594570&r2=1594571&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Wed May 14 13:08:18 2014
@@ -40,8 +40,9 @@ under the License.
     </menu>
     <menu name="Using Oak">
       <item href="use_getting_started.html" name="Getting Started" />
-      <item href="differences.html" name="Differences to Jackrabbit 2" />
+      <item href="construct.html" name="Repository construction" />
       <item href="osgi_config.html" name="Configuring Oak" />
+      <item href="differences.html" name="Differences to Jackrabbit 2" />
       <item href="known_issues.html" name="Known Issues" />
       <item href="dos_and_donts.html" name="Dos and don'ts" />
       <item href="when_things_go_wrong.html" name="When things go wrong" />