write README.md

Author: set0gut1

README.md

@@ -1 +1,43 @@
-# good-looking-repository
+# good-looking-repository
+
+This is an experiment how to improve the apearance of GitHub repoository on social media, like Twitter, Facebook and LinkedIn.
+
+Website: [https://set0gut1.github.io/good-looking-repository/](https://set0gut1.github.io/good-looking-repository/)
+
+## Comparison before and after improvement
+
+| media | repository itself | GitHub Page |
+| ---- | ---- | ---- |
+| Twitter | ![](img/repo-twitter.png) | ![](img/page-twitter.png) |
+| Facebook | ![](img/repo-facebook.png) | ![](img/page-facebook.png) |
+| LinkedIn | ![](img/repo-linkedin.png) | ![](img/page-linkedin.png) |
+
+## Problems at sharing a GitHub repository on social media
+
+Even if you want to display the application's logo when social media sharing, your account profile image (often is a face picture) is used as og:image.
+Your face is also stretched in LinkedIn. This is not good looking.
+
+A message is appended on twitter: "Contribute to <repository-name> development by creating an account on GitHub".
+I think this message is nice, but may not suitable on situation such that portrait list.
+
+## How to improve the appearance of social media
+
+The solution is to create an application website using the appropriate ogp tag and use it for sharing on social media.
+This is easy with the GitHub Pages.
+
+The things you need to do are followings:
+
+1. create some markdown file for website, or reuse README.md
+2. create a logo image (height: 630 / width: 1200 seems to be the best)
+3. create \_config.yml for jekyll configuration
+4. publish these with GitHub Pages
+
+and use the url of GitHub Page for sharing on social media.
+
+## Link to related information
+
+- checking tools for the appearance on social media
+    - [Twitter card validator](https://cards-dev.twitter.com/validator/)
+    - [Facebook share debugger](https://developers.facebook.com/tools/debug/)
+- [About Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag/tree/master/docs)
+- Issue on github: [Support custom (per repository) og:image thumbnails.](https://github.com/isaacs/github/issues/612)

_config.yml

@@ -6,6 +6,6 @@ defaults:
       path: ""
     values:
       image:
-        path: /logo.jpg
+        path: /img/logo.jpg
         height: 630
         width: 1200