feat: simplify output + improve types + clean readme

[DoneDeal0]

BREAKING CHANGE:

subPropertiesDiff has been removed from the getObjectDiff output. There is now a single recursive diff key for more simplicity.

The new model is:

/** recursive diff in case of subproperties */
export type Diff = {
  property: string;
  previousValue: unknown;
  currentValue: unknown;
  status: OBJECT_STATUS;
  diff?: Diff[];
};

export type ObjectDiff = {
  type: "object";
  status: OBJECT_STATUS;
  diff: Diff[];
};

The types have also been improved.

[github-actions]

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀