adding omit, tests, and readme info

don't modify the object that is passed, clone the object first.