updated readme and public interface