.ghuser.io.json // #3

ghuser-io · Jun 27, 2018 · d445ed2 · d445ed2
1 parent 3045204
commit d445ed2
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 1 deletion.
diff --git a/.ghuser.io.json b/.ghuser.io.json
@@ -0,0 +1,4 @@
+{
+  "_comment": "Settings for ghuser.io. See https://github.com/AurelienLourot/ghuser.io/blob/master/docs/repo-settings.md",
+  "avatar_url": "https://rawgit.com/AurelienLourot/ghuser.io/master/docs/logo_square.png"
+}
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 <p align="center">
   <a href="https://ghuser.io">
-    <img src="https://rawgit.com/AurelienLourot/ghuser.io/master/logo.png"
+    <img src="https://rawgit.com/AurelienLourot/ghuser.io/master/docs/logo.png"
          width="400" height="108" />
   </a>
 </p>

diff --git a/logo.md → docs/logo.md b/logo.md → docs/logo.md
diff --git a/logo.png → docs/logo.png b/logo.png → docs/logo.png
diff --git a/docs/logo_square.png b/docs/logo_square.png
diff --git a/docs/repo-settings.md b/docs/repo-settings.md
@@ -0,0 +1,15 @@
+# Per-repo settings
+
+You can define an avatar for any `owner/repo` by committing a `.ghuser.io.json` file in
+`https://github.com/owner/repo`:
+
+```json
+{
+  "_comment": "Settings for ghuser.io. See https://github.com/AurelienLourot/ghuser.io/blob/master/docs/repo-settings.md",
+  "avatar_url": "https://rawgit.com/AurelienLourot/ghuser.io/master/docs/logo_square.png"
+}
+```
+
+This avatar will be used on any ghuser-profile mentioning this repo.
+
+See [this example](../.ghuser.io.json).