feat: add avatar for repositories

huchenme · Jun 22, 2019 · bab1866 · bab1866
1 parent d6761a6
commit bab1866
Show file tree

Hide file tree

Showing 9 changed files with 2,058 additions and 2,011 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -21,10 +21,12 @@ module.exports = {
     'no-console': 'off',
     'consistent-return': 'off',
   },
-  overrides: {
-    files: ['**/__tests__/**/*.ts'],
-    rules: {
-      '@typescript-eslint/explicit-function-return-type': 'off',
+  overrides: [
+    {
+      files: ['**/__tests__/**/*.ts'],
+      rules: {
+        '@typescript-eslint/explicit-function-return-type': 'off',
+      },
     },
-  },
+  ],
 };
diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@
 - [Projects using github-trending-api](#projects-using-github-trending-api)
 - [API Status](#api-status)
 - [REST API](#rest-api)
+- [Tutorial](#tutorial)
   - [Trending Repositories](#trending-repositories)
   - [Trending Developers](#trending-developers)
   - [List Languages](#list-languages)
@@ -52,6 +53,7 @@
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <!-- prettier-ignore-end -->
+
 </details>
 
 ## Projects using github-trending-api
@@ -101,6 +103,7 @@ https://github-trending-api.now.sh/repositories?language=javascript&since=weekly
   {
     "author": "google",
     "name": "gvisor",
+    "avatar": "https://github.com/google.png",
     "url": "https://github.com/google/gvisor",
     "description": "Container Runtime Sandbox",
     "language": "Go",
@@ -252,7 +255,7 @@ Receive an array of trending repositories.
 
 **params**:
 
-- `language`: possible values are the the ones from `fetchAllLanguages()` or [just find here](languages.json).
+- `language`: possible values are the the ones from `fetchAllLanguages()` or [just find here](./src/languages.ts).
 - `since`: `daily`, `weekly` or `monthly`, default to `daily`.
 
 ```js
@@ -261,6 +264,7 @@ Receive an array of trending repositories.
   {
     author: 'google',
     name: 'gvisor',
+    avatar: 'https://github.com/google.png',
     url: 'https://github.com/google/gvisor',
     description: 'Container Runtime Sandbox',
     language: 'Go',

diff --git a/apiary.apib b/apiary.apib
@@ -20,6 +20,7 @@ GitHub Trending API is a simple API to fetch trending repositories and developer
             {
                 "author": "xingshaocheng",
                 "name": "architect-awesome",
+                "avatar": "https://github.com/xingshaocheng.png",
                 "url": "https://github.com/xingshaocheng/architect-awesome",
                 "description": "后端架构师技术图谱",
                 "stars": 7333,
@@ -36,6 +37,7 @@ GitHub Trending API is a simple API to fetch trending repositories and developer
             {
                 "author": "google",
                 "name": "gvisor",
+                "avatar": "https://github.com/google.png",
                 "url": "https://github.com/google/gvisor",
                 "description": "Container Runtime Sandbox",
                 "language": "Go",
@@ -54,6 +56,7 @@ GitHub Trending API is a simple API to fetch trending repositories and developer
             {
                 "author": "davideuler",
                 "name": "architecture.of.internet-product",
+                "avatar": "https://github.com/davideuler.png",
                 "url": "https://github.com/davideuler/architecture.of.internet-product",
                 "description": "互联网公司技术架构，微信/淘宝/腾讯/阿里/美团点评/百度/微博/Google/Facebook/Amazon/eBay的架构，欢迎PR补充",
                 "stars": 2763,
@@ -70,6 +73,7 @@ GitHub Trending API is a simple API to fetch trending repositories and developer
             {
                 "author": "kusti8",
                 "name": "proton-native",
+                "avatar": "https://github.com/kusti8.png",
                 "url": "https://github.com/kusti8/proton-native",
                 "description": "A React environment for cross platform native desktop apps",
                 "language": "JavaScript",