More detail for the ReadMe

Author: Stray

README.md

@@ -50,7 +50,37 @@ In the command itself - named injection only required where you have multiple ev
 	[Inject(name='stuffHappened')]
 	public var stuffHappenedEvent:SomeOtherEvent;
 
-etc - but there's a common use case where you'd only be interested in the fact that all 3 events have fired and wouldn't need the events at all, or would only need the last one.  
+etc - but there's a common use case where you'd only be interested in the fact that all 3 events have fired and wouldn't need the events at all, or would only need the last one. 
+
+
+ICompoundCommandMap has an API with 3 functions:
+
+	function mapToEvents(commandClass:Class, oneshot:Boolean = false, requiredInOrder:Boolean = false):ICompoundCommandConfig;
+	 
+	function hasCompoundCommand(commandClass:Class):Boolean;
+	
+	function unmapCompoundCommand(commandClass:Class):ICompoundCommandConfig;
+	
+	
+ICompoundCommandConfig - returned when mapping / unmapping - has the API:
+
+	function addRequiredEvent(eventType:String, eventClass:Class = null, named:String = ""):ICompoundCommandConfig;
+	
+	// all events set using addRequiredEvent
+	function get requiredEvents():Array;
+	
+	// events that have not yet fired
+	function get remainingRequiredEvents():Array;
+	
+	// whether the events are only picked up in order - ie event2 is ignored until after event1 is received
+	function get requiredInOrder():Boolean;
+	
+	/* returns an array of the events that have arrived so far as a strong typed IEventAsPayload with 3 properties:
+	   the event, the event class and the event name if it was mapped with a name  */
+	function get eventsAsPayloads():Array;
+	
+	function get oneshot():Boolean;
+	
 
 See tests/org/robotlegs/base/CompoundCommandMapTest for full usage examples.