Update Readme

Author: MoeweX

README.md

@@ -1,35 +1,29 @@
-# Configuration
+# FBase
 
-If the S3 connector is supposed to be used, AWS credentials must be set locally as described [here](http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html).
+FBase can be build by running `mvn clean package`. Do not forget to run `mvn clean install` in the local FBaseCommons repository as it is one of the dependencies. In addition, the Naming Service should be up and running.
 
-# How to run the tests
+The easiest way to startup FBase is by just using the jar file (with dependencies) produced by maven. The only argument that needs to be provided is the path to the config file. For an example config file check out `src/main/resources/sample_config.properties.`, make sure that the initialNodeConfig of the naming service is compatible to the configuration of the first FBase node started (nodeID and encryption information), because otherwise it cannot communicate with the Naming Service.
 
-For some of the tests, a running naming service is required. The naming service has to be started in debug mode and must add an initial node that equals us as configured in the FBase configuration files. The naming service address must configured in the different configuration files for each test individually.
+If you need to generate a private/public RSA key, use the `RSAHelper` class' main method.
+
+## S3 Connector
 
-# Current ToDos / Missing Functionality
+If the S3 connector is supposed to be used, AWS credentials must be set locally as described [here](http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html).
+
+## How to run the tests
 
-## Startup
-- [x] A machineName should be dynamically created on Startup (clean up configs)
-- [x] Run AddMachineToNodeTask (ended up not being a task)
+For some of the tests, a running naming service is required. The naming service has to be started in debug mode and must add an initial node that equals us as configured in the FBase configuration files. The naming service address must configured in the different configuration files for each test individually.
 
-## Subscription Management incl. Heartbeats
-- See ImplementationSubscriptionManagement.md
+## Current ToDos not listed in code
 
-## One to One Communication
+### One to One Communication
 - [ ] Add one to one communication for datarecords
-- [ ] Add one to one communication for machine addition announcement
 
-## Storage
+### Storage
 - [ ] Remove data that is expired
 
 ### Handling Missed Messages
-- [x] Add message history size to machine config (node specific), cleanup config files
-- [ ] (Add message history cleanup functionality (on receiver and sender side), not implemented in thesis)
+- [ ] Add message history cleanup functionality (on receiver and sender side)
 
-## Controlling FBase with Clients
+### Controlling FBase with Clients
  - [ ] Enable encryption and authentication
- - [ ] Method to instruct machine to update all configurations with naming service data
- - [x] Keygroup C, R, D
- - [x] Keygroup all update methods
- - [X] Client C, D
- - [X] DataRecord P, R, D, List

src/main/java/communication/MessageIdEvaluator.java

@@ -31,8 +31,6 @@
  * he finds a gap, he will create a directMessageSender and ask the related node about the send
  * data.
  * 
- * TODO 2: clean ID storage from time to time
- * 
  * @author jonathanhasenburg
  *
  */

src/main/java/control/FBase.java

@@ -40,11 +40,6 @@
 /**
  * Main control class of a FBase machine.
  * 
- * TODO 2: Missing functionality: <br>
- * * clean up of data records that are stored longer than needed<br>
- * * clean up of message history of outgoing messages
- * * enable encryption for client communication
- * 
  * @author jonathanhasenburg
  *
  */