Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 0cbf3be

Browse files
committed
Update README
1 parent dd64c97 commit 0cbf3be

File tree

2 files changed

+17
-39
lines changed

2 files changed

+17
-39
lines changed

‎README.md

Lines changed: 12 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# CODING Toolkit
1+
# CODING Toolkit Sketch Plugin
2+
3+
<img src='https://user-images.githubusercontent.com/5106039/80296781-61060600-87b0-11ea-8dd4-d9a15d29d9cd.png' width='674px'>
4+
5+
## 插件命令
6+
7+
### 1. Update Icon 升级图标
8+
用于替换旧版 CODING Icon 至新版 CODING Icon,在设计稿中选中来自旧版的 CODING Icon Library 的 symbol 然后执行此命令即可自动替换为对应的新版 CODING ICON,并且保留原来 icon 覆盖的颜色。
9+
10+
### 2. Genrarte Icon Library Collection 生成图标合集
11+
用与在 CODING Icon Library 文件中修改或添加 icon 后重新生成 icon 集合,以便在 Abstract 中查找 icon。执行此命令将会自动删除原 Page 1 中的 icon collection 画板然后重新生成新的画板。
12+
更新 CODING Icon 的具体方法请查看此 [Wiki](https://codingcorp.coding.net/p/Design-Center/wiki/1495)
213

314
## Installation
415

@@ -36,33 +47,6 @@ Additionally, if you wish to run the plugin every time it is built:
3647
npm run start
3748
```
3849

39-
### Custom Configuration
40-
41-
#### Babel
42-
43-
To customize Babel, you have two options:
44-
45-
- You may create a [`.babelrc`](https://babeljs.io/docs/usage/babelrc) file in your project's root directory. Any settings you define here will overwrite matching config-keys within skpm preset. For example, if you pass a "presets" object, it will replace & reset all Babel presets that skpm defaults to.
46-
47-
- If you'd like to modify or add to the existing Babel config, you must use a `webpack.skpm.config.js` file. Visit the [Webpack](#webpack) section for more info.
48-
49-
#### Webpack
50-
51-
To customize webpack create `webpack.skpm.config.js` file which exports function that will change webpack's config.
52-
53-
```js
54-
/**
55-
* Function that mutates original webpack config.
56-
* Supports asynchronous changes when promise is returned.
57-
*
58-
* @param {object} config - original webpack config.
59-
* @param {boolean} isPluginCommand - whether the config is for a plugin command or a resource
60-
**/
61-
module.exports = function(config, isPluginCommand) {
62-
/** you can change config here **/
63-
}
64-
```
65-
6650
### Debugging
6751

6852
To view the output of your `console.log`, you have a few different options:
@@ -80,13 +64,3 @@ skpm publish <bump>
8064

8165
`skpm publish` will create a new release on your GitHub repository and create an appcast file in order for Sketch users to be notified of the update.
8266

83-
You will need to specify a `repository` in the `package.json`:
84-
85-
```diff
86-
...
87-
+ "repository" : {
88-
+ "type": "git",
89-
+ "url": "git+https://github.com/ORG/NAME.git"
90-
+ }
91-
...
92-
```

‎package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,9 @@
2323
"devDependencies": {
2424
"@skpm/builder": "^0.7.0"
2525
},
26-
"author": "tankxu <xutan@coding.net>"
26+
"author": "tankxu <xutan@coding.net>",
27+
"repository" : {
28+
"type": "git",
29+
"url": "git+https://github.com/Coding/coding-sketch-toolkit.git"
30+
}
2731
}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /