updated readme, and private methods