Adding run instructions to README (#98)

.gitignore

@@ -5,4 +5,5 @@ target/
 *.jar
 *.log
 .idea/
-.git/
+.git/
+dependency-reduced-pom.xml

README.md

@@ -1,7 +1,34 @@
 # StunDB - A stunning distributed key-value database
 
-## Work in progress - Not ready for production yet
+----------------------------
 
+## Disclaimer
+
+This application is work in progress, so it is not ready for production yet.
+
+----------------------------
+
+## Running
+
+### Jar
+
+1. Download the runnable jar from the latest [release](https://github.com/rafaelsilverioit/stundb/releases)
+2. In the same folder where the jar is placed, create a file named `application.yml` with contents similar to [this](https://github.com/rafaelsilverioit/stundb/blob/1.0.0/stundb/application/src/main/resources/application.yml)
+3. Run the application with the following command: 
+```bash
+  java -jar stundb-application-1.0.0-shaded.jar -Dapplication.port=8000
+```
+
+### Maven
+
+To run with Maven, you just need to run the following command:
+```bash
+  mvn exec:java -f stundb/application/pom.xml
+```
+
+----------------------------
+
+## Backlog
 ### Done
 - FIFO cache
 - Locking

stundb/application/pom.xml

@@ -153,6 +153,33 @@
                     </archive>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>shade</goal>
+                        </goals>
+                        <configuration>
+                            <shadedArtifactAttached>true</shadedArtifactAttached>
+                            <transformers>
+                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                                    <mainClass>com.stundb.ApplicationMain</mainClass>
+                                </transformer>
+                            </transformers>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>3.2.0</version>
+                <configuration>
+                    <mainClass>com.stundb.ApplicationMain</mainClass>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 </project>