chore: fix readme file

README.md

@@ -19,23 +19,23 @@ This package offer a set of functions to retrieve information about the monorepo
 
 | ###Function | ###Description |
 |---|---|
-| `getProjectRootPath(root?: string): string | undefined` | Get the root path of the project. |
-| `getDefinedPackageManager(root?: string): string | undefined` | Get the package manager defined in the project. |
-| `detectPackageManager(root: string): PackageManager | undefined` | Detect the package manager defined in the project. |
+| `getProjectRootPath(root?: string): string or undefined` | Get the root path of the project. |
+| `getDefinedPackageManager(root?: string): string or undefined` | Get the package manager defined in the project. |
+| `detectPackageManager(root: string): PackageManager or undefined` | Detect the package manager defined in the project. |
 | `getPackages(cwd?: string): Array<PackageInfo>` | Get the list of packages in the monorepo. |
 | `getChangedPackages(sha?: string, cwd: string): Array<PackageInfo>` | Get the list of packages that have changed since the given sha ('main'). |
 | `gitFetchAll(cwd?: string, fetch_tags?: boolean): boolean` | Execute a `fetch` command to get the latest changes from the remote repository. You can also retrieve tags |
 | `gitCommit(message: string, body?: string, footer?: string cwd?: string): boolean` | Commit the changes. |
 | `gitTag(tag: string, message?: string, cwd?: string): boolean` | Tag the repository with the given tag. |
 | `gitPush(cwd?: string, follow_tags?: boolean): boolean` | Push the changes to the remote repository, including optional tags. |
-| `gitCurrentBranch(cwd?: string): string | undefined` | Get the current branch name. |
+| `gitCurrentBranch(cwd?: string): string or undefined` | Get the current branch name. |
 | `gitCurrentSha(cwd?: string): string` | Get's the current commit id. |
-| `gitPreviousSha(cwd?: string): string | undefined` | Get's the previous commit id. |
-| `gitFirstSha(cwd?: string, branch?: string): string | undefined` | Get's the first commit id in a branch. Compare is done between branch..Head, and it should be used as main..HEAD |
+| `gitPreviousSha(cwd?: string): string or undefined` | Get's the previous commit id. |
+| `gitFirstSha(cwd?: string, branch?: string): string or undefined` | Get's the first commit id in a branch. Compare is done between branch..Head, and it should be used as main..HEAD |
 | `isWorkdirUnclean(cwd?: string): boolean` | Check if the workdir is unclean (uncommited changes). |
-| `gitCommitBranchName(sha: string, cwd?: string): string | undefined` | Get the branch name for the commit id. |
+| `gitCommitBranchName(sha: string, cwd?: string): string or undefined` | Get the branch name for the commit id. |
 | `gitAllFilesChangedSinceSha(sha: string, cwd?: string): Array<String>` | Get all files changed sinc branch, commit id etc. |
-| `getDivergedCommit(sha: string, cwd?: string): string | undefined` | Get the diverged commit from the given sha (main). |
+| `getDivergedCommit(sha: string, cwd?: string): string or undefined` | Get the diverged commit from the given sha (main). |
 | `getCommitsSince(cwd?: string, since?: string, relative?: string): Array<Commit>` | Get the commits since the given sha (main) for a particular package. |
 | `getAllFilesChangedSinceBranch(package_info: Array<PackageInfo>, branch: string, cwd?: string): Array<String>` | Get all the files changed for a branch (main). |
 | `getLastKnownPublishTagInfoForPackage(package_info: PackageInfo, cwd?: string): Array<PublishTagInfo>` | Get the last known publish tag info for a particular package. |