🐱🐱 为每个图片添加独立样式，更新文档

tgbamg · May 27, 2018 · d3a1bfe · d3a1bfe
1 parent 1cf96ef
commit d3a1bfe
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -5,87 +5,78 @@
 [![Ratings](https://vsmarketplacebadge.apphb.com/rating/shalldie.background.svg)](https://vsmarketplacebadge.apphb.com/rating/shalldie.background.svg)
 
 ## Add a lovely background-image to your vscode.
- <br />
-
+
 GitHub: [https://github.com/shalldie/vscode-background](https://github.com/shalldie/vscode-background)
 
 Vscode Market: [https://marketplace.visualstudio.com/items?itemName=shalldie.background](https://marketplace.visualstudio.com/items?itemName=shalldie.background)
 
-----------------------------------------------------------------------------------
+## It looks like:
 
-### Notice 提示
+![](https://user-images.githubusercontent.com/9987486/40583705-7105dda8-61c6-11e8-935a-3c5d475a1eb1.gif)
 
-**http** 协议的外链图片在当前版本不能使用(vscode 限制)，需要用 **https** 协议开头的外链地址。
+## Warns 警告：
 
-You should use protocol **https** instead of **http** to the image,which is not support by vscode now.
+> **本插件是通过修改 vscode 的 css 文件的方式运行**  
+> 所以会在初次安装，或者 vscode 升级的时候，出现以下提示，请选择 【不再提示】:
+>
+> **This extension works by editting the vscode's css file.**  
+> So, a information appears while the first time to install or vscode update.U can click the [never show again] to avoid it.
+
+![](https://user-images.githubusercontent.com/9987486/40583926-b1fb5398-61ca-11e8-8271-4ac650d158d3.png)
 
-### Cross all themes, cross most os! 已支持所有主题，大部分操作系统(window,os x,linux)！
-### It looks like:
- <br />
+This is the reason:
 
-![](https://github.com/shalldie/vscode-background/raw/master/gif/show.gif)
-
-----------------------------------------------------------------------------------
-### Warns 警告：
-<br/>
-
-![](https://github.com/shalldie/vscode-background/raw/master/gif/info.png)
+![](https://user-images.githubusercontent.com/9987486/40583775-91d4c8d6-61c7-11e8-9048-8c5538a32399.png)
 
-**本插件是通过修改vscode的css文件的方式运行**
+## Config 配置项
 
-**This extension works by editting the vscode's css file.**
+| Name                      |      Type       | Description                                                                                 |
+| :------------------------ | :-------------: | :------------------------------------------------------------------------------------------ |
+| `background.enabled`      |    `Boolean`    | 插件是否启用 <br> If background enabled.                                                    |
+| `background.useDefault`   |    `Boolean`    | 是否使用默认图片 <br> If use default images.                                                |
+| `background.customImages` | `Array<String>` | 自定义图片，最多 3 个<br> Your Your custom Images(Max length is 3)                          |
+| `background.style`        |    `Object`     | 自定义样式 <br> Custom style                                                                |
+| `background.styles`       | `Array<Object>` | 每个图片的独立样式 <br> Style of each image.                                                |
+| `background.useFront`     |    `Boolean`    | 前景图/背景图。 在代码上面还是下面 <br> `true`:On the top of code. `false`: Behind the code |
 
-    在vscode 1.6.1 的时候，出现了这个提示。你可以先点击【不再显示】.
-    我去官网查了一下，目前已经不建议使用注入代码的方式完成功能。
-    本插件是钻了个漏洞。
+## Notice 提示
+
+**http** 协议的外链图片在当前版本不能使用(vscode 限制)，需要用 **https** 协议开头的外链地址。
+
+You should use protocol **https** instead of **http** to the image,which is not support by vscode now.
 
-    At vscode ver 1.6.1 ,a information appears while opening vscode.
-    U can click the last button(never show again) to avoid it.
-    This Extension is edit the vscode's file to make it work,which is not recommended now.
+## Uninstall 卸载
 
-------
+    Set the config  {"background.enabled": false}  in settings.json,then uninstall the plugin.
+    在 settings.json 中设置 {"background.enabled": false} ，然后再删除插件。如果直接删除插件会有遗留，就需要重装vscode了。
 
 ### Q&A 常见问题:
 
-    Q:How to use it?
-    Q:插件是怎么用的？
+---
 
-    A:After installing the extension,the default images will be added to background.U can config it in settings.json.
-    A:安装插件之后，默认图片就会被添加到背景中。settings.json 里面有很多都是可以配置的。
-  ![](https://github.com/shalldie/vscode-background/raw/master/gif/settings.png)
-
-    新特性:"background.style":{} ，可以在里面添加自己的样式，包括 【"opacity":0.6】
-***
     Q:It seems that nothing happens after installing the extension?
     Q:安装完插件后，似乎没有反应？
 
     A:Make sure to have the administrator authority！！
     A:如果不能使用，请确保你有管理员权限！！
-*** 
+
+---
+
     Q:How to get the administrator authority?
     Q:怎么获取管理员权限呢？ =。=
-    
+
     A:In windows,click right button on the vscode's icon,then check the [run with the administrator authority].
     A:在windows环境中，可以右键单击vscode的图标，选择【以管理员身份运行】。
-***
-  In ubuntu:[https://github.com/shalldie/vscode-background/issues/6](https://github.com/shalldie/vscode-background/issues/6).
-***
-    Q:How to uninstall the extension?
-    Q:怎么卸载这个插件？
-
-    A:Set the config  {"background.enabled": false}  in settings.json,then uninstall the plugin.
-    A:在 settings.json 中设置 {"background.enabled": false} ，然后再删除插件。如果直接删除插件会有遗留，就需要重装vscode了。
-***
-    Q:Where is the settings.json?
-    Q:【settings.json】 这个文件在哪里？
-
-    A: 【文件(F)】-【首选项(P)】-【设置(S)】
-***
-
-Press F1,and you can get it by enter **ext install background** in your vscode. (～￣▽￣)～
+
+---
+
+In ubuntu:[https://github.com/shalldie/vscode-background/issues/6](https://github.com/shalldie/vscode-background/issues/6).
+
+Press F1,and you can get it by enter **ext install background** in your vscode. (～￣ ▽ ￣)～
 <br />
 <br />
-你可以在vscode中，按下F1，然后输入 **ext install background** 来下载她 (～￣▽￣)～
-*** 
+你可以在 vscode 中，按下 F1，然后输入 **ext install background** 来下载她 (～￣ ▽ ￣)～
+
+---
 
 **Enjoy!**
diff --git a/gif/command.png b/gif/command.png
diff --git a/gif/info.png b/gif/info.png
diff --git a/gif/logo.png b/gif/logo.png
diff --git a/gif/settings.png b/gif/settings.png
diff --git a/gif/show.gif b/gif/show.gif
diff --git a/package.json b/package.json
@@ -2,12 +2,16 @@
     "name": "background",
     "displayName": "background",
     "description": "A simple tool to make your vscode's background look better!",
-    "version": "1.1.17",
+    "version": "1.1.18",
     "publisher": "shalldie",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/shalldie/vscode-background.git"
+    },
     "engines": {
         "vscode": "^1.17.0"
     },
-    "icon": "gif/logo.png",
+    "icon": "https://user-images.githubusercontent.com/9987486/40583704-6accf3a4-61c6-11e8-8c00-a636b9c3ec65.png",
     "categories": [
         "Other"
     ],