Fix indentation, add documentation, and remove unneeded files
Change-Id: Ie40ec66c611690656ca451759f82154686ca0ec3
diff --git a/README.md b/README.md
index a0011f6..e282cef 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,9 @@
This project consists of tools for testing NDN applications without network IO. It relies on the [NDN Protocol](https://named-data.net) and its associated [client library](https://github.com/named-data/jndn).
## Install
+
With Maven, add the following to your POM:
-```
+```xml
<dependency>
<groupId>com.intel.jndn.mock</groupId>
<artifactId>jndn-mock</artifactId>
@@ -13,18 +14,30 @@
```
## Use
-`MockFace` and `MockTransport` are test tools that can be passed to applications instead of the typical `Face` and `Transport`. For example:
-```
-MockTransport transport = new MockTransport();
-MockFace face = new MockFace(transport, null);
-application.doSomethingOn(face);
-assertEquals(0, transport.getSentDataPackets().size());
-assertEquals(1, transport.getSentInterestPackets().size());
+`MockFace` is a test tool that can be passed to applications instead of a network IO `Face`; management of the `Face.processEvents()` is still the user's responsibility, though this may change in a future release. For example:
+```java
+Face face = new MockFace();
+face.expressInterest(interest, onData, onTimeout);
+face.processEvents();
+```
+
+When using the `MockFace`, retrieve statistics about sent/received Interests and Data packets like:
+```java
+MockFace face = new MockFace();
+assertEquals(0, face.sentDatas.size());
+assertEquals(0, face.sentInterests.size());
+
+face.expressInterest(interest, onData, onTimeout);
+...
+face.processEvents();
+...
+assertEquals(1, face.sentInterests.size());
```
## License
-Copyright © 2015, Intel Corporation.
+
+Copyright 2015, Intel Corporation.
This program is free software; you can redistribute it and/or modify it under the terms and conditions of the GNU Lesser General Public License, version 3, as published by the Free Software Foundation.