Update documentation

Author: philipstanislaus

README.md

@@ -11,7 +11,7 @@ This client is modelled after [polkadot-js/api](https://github.com/polkadot-js/a
 
 ## State
 
-This package is actively developed. The first stable release is expected in November 2019.
+This package is feature complete, but it is relatively new and might still contain bugs. We advice to use it with caution in production. It comes without any warranties, please refer to LICENCE for details.
 
 ## Documentation & Usage Examples
 

types/event_record.go

@@ -293,6 +293,9 @@ type EventRecords struct {
 }
 
 // DecodeEventRecords decodes the events records from an EventRecordRaw into a target t using the given Metadata m
+// If this method returns an error like `unable to decode Phase for event #x: EOF`, it is likely that you have defined
+// a custom event record with a wrong type. For example your custom event record has a field with a length prefixed
+// type, such as types.Bytes, where your event in reallity contains a fixed width type, such as a types.U32.
 func (e EventRecordsRaw) DecodeEventRecords(m *Metadata, t interface{}) error {
 	log.Debug(fmt.Sprintf("will decode event records from raw hex: %#x", e))