add some docs

5l1v3r1 · Aug 29, 2022 · 973c999 · 973c999
1 parent ea356b2
commit 973c999
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/config-example.json b/config-example.json
@@ -15,7 +15,8 @@
         "AnotherGitRepo" : {
             "url" : "https://www.github.com/YourOrganization/RepoOne.git",
             "ms-between-poll": 10000,
-            "exclude-dot-files": true
+            "exclude-dot-files": true,
+            "auto-generated-files": ["example/path"]
         },
         "GitRepoWithDetectRefDisabled" : {
             "url" : "https://www.github.com/YourOrganization/RepoOne.git",

diff --git a/docs/config-options.md b/docs/config-options.md
@@ -2,6 +2,7 @@
   * [Git options](#git-options)
   * [SVN options](#svn-options)
   * [URL options](#url-options)
+  * [Misc options](#misc-options)
 
 
 
@@ -46,3 +47,11 @@ URLOptions | Description | Default Values
 :------ | :--- | :-----
 url-pattern | when provided used by Hound for config|`{url}/blob/{rev}/{path}{anchor}`
 anchor | when provided used for vcs config| `#L{line}`
+
+## Misc Options
+These options are available for repos
+
+Options | Description | Default Values
+:------ | :--- | :-----
+exclude-dot-files | excludes filenames that start with dot|`true`
+auto-generated-files | marks filenames as autogenerated in UI| `[]` (for git, Hound checks for git attributes with the `linguist-generated` attribute)