Update README.md

README.md

@@ -4,72 +4,66 @@
 
 
 ### The Point
+* You are to write a command interpreter using the provided `SimpleShell` class.
+* You're going to create a way
+	* for commands to be typed into your shell,
+	* to read the typed commands and arguments,
+	* to send them off to the Under-A-Rock server using a REST API over the HTTP protocol,
+	* to read the JSON data returned from the URL call,
+	* to print it out nicely formatted for your user. 
 
-You are to write a command interpreter using the provided SimpleShell class. You're going to create a way for 
-commands to be typed into your shell, read the typed commands and arguments, send them off to the Under-A-Rock 
-server using a REST API over the HTTP protocol, read the JSON data returned from the URL call, and print it out 
-nicely formatted for your user. If you manage to get this all done in a reasonable time, attempt parts 2 and 3.
+* `Under-A-Rock` acts a little (very little) like a twitter server or chat server.
+	* You register your name and github id by creating an ID JSON payload (see below) and POSTing it to the server.
+	* You can GET all the ids registered by sending a GET request to the same URL.
+	* Once you've received all the ids, you can send messages to the world or to a specific `Github_id`.
 
-Under-A-Rock acts a little (very little) like a twitter server or chat server. 
 
-You register your name and githubid by creating an ID JSON payload (see below) and POSTing it to the server. You can GET 
-all the ids registered by sending a GET request to the same URL. Once you've received all the ids, you can send
-messages to the world or to a specific Github_id.
 
-You 
-can send a message to the global timeline by POSTing a Message JSON object to the URL below.
-If you leave the "to id" field empty, the message is "to the world". If you fill out the the JSON template with
-a valid github_id in the "to id" field of the JSON payload, then that message is addressed to that friend. Yes, all 
-messages can be seen by users of the system. There are JSON templates below for both Ids and Messages.
+* You can send a message to the global timeline by POSTing a Message JSON object to the URL below.
+	* If you leave the `to id` field empty, the message is `to the world`.
+	* If you fill out the the JSON template with a valid github_id in the `to id` field of the JSON payload, then that message is addressed to that friend.
+	* Yes, all messages can be seen by users of the system.
+	* There are JSON templates below for both Ids and Messages.
 
-When you send a new Message or Id JSON object to the server, it records it, and fills in one or two fields. 
-A Message gets an assigned sequence number and a timestamp of when it was received by the server. An ID
-object gets a "user id" field assigned to it.
-Any sequence number, timestamp or userid you put into a JSON template
-gets overwritten by the server when you POST it. 
 
-You're going to create a series of REST API handlers that will each perform a 
-specific command. Each one of the command methods will then call a even lower-level method that makes a certain kind
-of HTTP request (GET, POST, PUT) to specific filled-in URL.
 
-The Under-A-Rock Server can be reached at `http://zipcode.rocks:8085` Everyone uses the same server. 
+* When you send a new Message or Id JSON object to the server, it records it, and fills in one or two fields. 
+	* A Message gets an assigned sequence number and a timestamp of when it was received by the server.
+	* An ID object gets a "user id" field assigned to it.
+	* Any sequence number, timestamp or userid you put into a JSON template gets overwritten by the server when you POST it. 
 
-There are two segments to the API and two kinds of commands in the shell, the ID segment and the Messages segment.
 
 
-You can explore several ways of doing the HTTP URL calls to the server, using the one of these:
-* Core Java version 
-URL https://docs.oracle.com/javase/8/docs/api/java/net/URL.html and 
-HttpURLConnection https://docs.oracle.com/javase/8/docs/api/java/net/HttpURLConnection.html, 
-* Apache HTTP Client Library http://hc.apache.org/httpcomponents-client-ga/index.html
-* Unirest for Java http://unirest.io/java.html
-* Square's OKHttp https://github.com/square/okhttp
+* You're going to create a series of REST API handlers that will each perform a 
+specific command.
+	* Each one of the command methods will then call a even lower-level method that makes a certain kind of HTTP request (GET, POST, PUT) to specific filled-in URL.
 
-Be prepared to defend your choice if which HTTP client library you chose, with reasons why you chose it.
-You should also create some unit tests for your REST API handlers. You should look at how ItelliJ does management of
-dependencies. (You'll be modifying the `pom.xml` file.) Usually, you merely need to add a `dependency` clause to the `dependencies`
-clause in the pom.xml. 
+* The Under-A-Rock Server can be reached at `http://zipcode.rocks:8085` Everyone uses the same server. 		
+	* There are two segments to the API and two kinds of commands in the shell, the ID segment and the Messages segment.
 
-It's possible you may also need to understand some of what the Jackson package does for you. `jackson` will also need to be inserted into the `pom.xml` file, with a dependency clause.
 
-* jackson json https://github.com/FasterXML/jackson
+* You can explore several ways of doing the HTTP URL calls to the server, using the one of these:
+	* [Apache HTTP Client Library](http://hc.apache.org/httpcomponents-client-ga/index.html)
+	* [Unirest for Java](http://unirest.io/java.html)
+	* [Square's OKHttp](https://github.com/square/okhttp)
+	* Core Java:
+		* [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)
+		* [HttpURLConnection](https://docs.oracle.com/javase/8/docs/api/java/net/HttpURLConnection.html)
 
-And you may wish to create a couple classes `public class Message` and `public class Id` to make handling
-the abstractions implied by the API easier.
+* Be prepared to defend your choice if which HTTP client library you chose, with reasons why you chose it.
+	* You should also create some unit tests for your REST API handlers.
 
-Jackson can help you parse the json into objects,and objects back into JSON strings. Be sure to research how you can
-dependencies in the `pom.xml` so that Jackson, well, so that you can use Jackson in the project.
+* It's possible you may also need to understand some of what the [Jackson package](https://github.com/FasterXML/jackson) does.
 
 ## IDs
 
 #### ID commands in shell
-In the shell, 
-`ids` should return a formatted list of the IDs available to you.
+* In the shell, `ids` should return a formatted list of the IDs available to you.
+* `ids your_name your_github_id` command should post your Name and your GithubId to the server.
+* If you do this twice with two different Names, but the name GithubId, the name on the server gets changed.
 
-`ids your_name your_github_id` command should post your Name and your GithubId to the server.
-If you do this twice with two different Names, but the name GithubId, the name on the server gets changed.
-
-the IDs API is:
+-
+### The IDs API is:
 
 #### URL: /ids/
 * `GET` : Get all github ids registered
@@ -77,6 +71,7 @@ the IDs API is:
 * `PUT` : change the name linked to your github id
 
 json payload for /ids/ - this is a sample
+
 ```json
 {
     "userid": "-", // gets filled w id
@@ -85,14 +80,9 @@ json payload for /ids/ - this is a sample
 }
 ```
  
- #### Example: 
- 
- if I type 
- ```aidl
-cmd?
- ids Kris xt0fer
-```
-  into the shell, your command processor creates a JSON object which looks like:
+#### Example: 
+If I type `cmd? ids Kris xt0fer` into the shell, your command processor creates a JSON object which looks like:
+
  ```json
  {
      "userid": "-", // gets filled w id
@@ -106,8 +96,7 @@ and send it as the body of a POST request to  `http://zipcode.rocks:8085/ids/`
 ## Messages
 
 #### Message comands in shell
-
-in the shell, 
+in the shell
 * `messages` should return the last 20 messages, nicely formatted.
 * `messages your_github_id` should return the last 20 messages sent to you.
 * `send your_github_id 'Hello World' ` should post a new message in the timeline
@@ -129,6 +118,7 @@ the Messages API is:
 * `GET` : Get last 20 msgs for myid from friendid
 
 json payload for /messages/ these are samples, one to a specific friend, one to the timeline.
+
 ```json
 [
   {
@@ -151,23 +141,25 @@ json payload for /messages/ these are samples, one to a specific friend, one to
 
 #### Example: 
  
- if I type 
- ```aidl
-cmd?
+if I type 
+``` cmd?
 send xt0fer 'Hello old buddy!' to torvalds
 ```
-  into the shell, your command processor creates a JSON object which looks like:
+into the shell, your command processor creates a JSON object which looks like:
+
  ```json
-  {
-     "sequence": "-",
-     "timestamp": "_",
-     "fromid": "xt0fer",
-     "toid": "torvalds",
-     "message": "Hello old buddy!"
-   }
+{
+	"sequence": "-",
+	"timestamp": "_",
+	"fromid": "xt0fer",
+	"toid": "torvalds",
+	"message": "Hello old buddy!"
+}
  ```
 and send it as the body of a POST request to  `http://zipcode.rocks:8085/ids/xt0fer/messages/`
 
+
+
 ## Part Two
 
 What's that ProcessBuilder stuff about? In the SimpleShell class, take a look. How can that be used