Skip to content

Commit 795d14a

Browse files
zzhongkellegous
authored andcommitted
clarify that file:// only works on local folders that are repositories (hound-search#232)
1 parent 81c9d59 commit 795d14a

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,8 @@ See [config-example.json](config-example.json) for examples of how to use each V
7272
7373
There are a couple of ways to get Hound to index private repositories:
7474
75-
* Use the `file://` protocol. This allows you to index any local folder, so you can clone the repository locally
76-
and then reference the files directly. The downside here is that the polling to keep the repo up to date will
77-
not work.
75+
* Use the `file://` protocol. This allows you to index a local clone of a repository. The downside here is that the polling to keep the repo up to date will
76+
not work. (This also doesn't work on local folders that are not of a supported repository type.)
7877
* Use SSH style URLs in the config: `"url" : "git@github.com:foo/bar.git"`. As long as you have your
7978
[SSH keys](https://help.github.com/articles/generating-ssh-keys/) set up on the box where Hound is running this will work.
8079

0 commit comments

Comments
 (0)