Docs: Updated API docs

Author: roman.vasilev

README.md

@@ -1,5 +1,6 @@
 # git-last-changed-files
 Get last changed files from git history commits
+Uses `git diff-tree` under the hood.
 
 INSTALL
 ---
@@ -10,9 +11,40 @@ npm install git-last-changed-files
 USAGE
 ---
 ```ts
-import { lastChangesFilesSync } from 'git-last-changed-files';
+import { lastChangesSync } from 'git-last-changed-files';
 
-lastChangesFilesSync({ test, size = 10, from = size, to = 0, count = countCommits() })
+lastChangesSync(options: Options): string[]
+```
+
+API
+---
+```ts
+type Options = {
+    /**
+     * Filter files by this anymatch.Matcher.
+     * If not set match to any file.
+     * https://github.com/micromatch/anymatch#anymatch-matchers-teststring-returnindex-startindex-endindex
+     * Default: null
+     */
+    test?: anymatch.Matcher;
+    /**
+     * Page size for checking git history.
+     * Default: 10
+     */
+    size?: number;
+    /**
+     * Begin from commit.
+     */
+    from?: number;
+    /**
+     * End to commit.
+     */
+    to?: number;
+    /**
+     * See changes recursively (flag `-r`)
+     */
+    recursive?: boolean;
+};
 ```
 
 CHANGELOG

src/index.ts

@@ -9,12 +9,32 @@ function countCommits() {
 }
 
 type Options = {
+    /**
+     * Filter files by this anymatch.Matcher.
+     * If not set match to any file.
+     * https://github.com/micromatch/anymatch#anymatch-matchers-teststring-returnindex-startindex-endindex
+     * Default: null
+     */
     test?: anymatch.Matcher;
+    /**
+     * Page size for checking git history.
+     * Default: 10
+     */
     size?: number;
+    /**
+     * Begin from commit.
+     */
     from?: number;
+    /**
+     * End to commit.
+     */
     to?: number;
-    count?: number;
+    /**
+     * See changes recursively (flag `-r`)
+     */
     recursive?: boolean;
+    /** @internal */
+    count?: number;
 };
 
 export function lastChangesSync({ test, size = 10, from = size, to = 0, count = countCommits(), recursive = true }: Options = {}): string[] {