The README isn't the appropriate place for a detailed documentation of the interface. Instead use a dedicated file and link to it from the README.