Fix to clarify repository option format

Closes GH-21. Reviewed-by: Titus Wormer <tituswormer@gmail.com>
remarkjs · Apr 7, 2020 · 168480a · 168480a
1 parent 2e23f2f
commit 168480a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/readme.md b/readme.md
@@ -116,7 +116,9 @@ These links are generated relative to a project.
 In Node this is detected automatically by loading `package.json` and looking for
 a `repository` field.
 In the browser, or when overwriting this, you can pass a `repository` in
-`options`.
+`options`.  
+The value of `repository` should be a URL to a GitHub repository, such as
+`'https://github.com/user/project.git'`, or only `'user/project'`.
 
 ###### Mentions