Skip to content
This repository has been archived by the owner on Dec 12, 2017. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
QingWei-Li committed Sep 11, 2016
1 parent 21ab95c commit 24f0434
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## [v1.0.0] 2016.09.11
- 修复 postcss 选项配置出错的问题
- 修复 clear 在开发模式也会执行的问题

## [v1.0.0-rc.3] 2016.09.06
- 修复 cooking-cli 的依赖
- update/import/remove 支持传入多个参数
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@
<a target="_blank" href="https://gitter.im/QingWei-Li/cooking?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img src="https://img.shields.io/gitter/room/QingWei-Li/cooking.svg?maxAge=2592000" alt="Gitter"></a>
</p>

## 文档
http://cookingjs.github.io
## 链接
- [文档](http://cookingjs.github.io)
- [例子](https://github.com/cooking-demo)
- [教程: 用 cooking 搭建一个简单又优雅的 Vue 项目开发环境 (入门篇)](https://zhuanlan.zhihu.com/p/22387692)

## 讨论
使用上遇到的问题请到 [Gitter 聊天室](https://gitter.im/QingWei-Li/cooking?utm_source=share-link&utm_medium=link&utm_campaign=share-link), issue 仅仅用来处理 bug 和 feature 等的问题。
Expand Down
36 changes: 35 additions & 1 deletion packages/cooking-cli/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# cooking-cli
# cooking
[![npm](https://img.shields.io/npm/dm/cooking-cli.svg?maxAge=2592000)]()
[![npm](https://img.shields.io/npm/v/cooking-cli.svg?maxAge=6000)](https://www.npmjs.com/package/cooking-cli)
[![gitter](https://img.shields.io/gitter/room/QingWei-Li/cooking.svg?maxAge=2592000)](https://gitter.im/QingWei-Li/cooking?utm_source=share-link&utm_medium=link&utm_campaign=share-link)

> [cooking](https://github.com/ElemeFE/cooking) 命令行工具

## Links
- [Docs](http://cookingjs.github.io)
- [Examples](https://github.com/cooking-demo)
- [Plugins](https://github.com/cookingjs)

## Installation
```shell
npm i cooking-cli -g
```

## Usages
```shell
# create vue project
cooking create vue-project vue

# development mode
cooking watch

# production mode
cooking build

# import plugin
cooking import vue,lint
```

# License
[MIT](https://github.com/ElemeFE/cooking/LICENSE)
47 changes: 45 additions & 2 deletions packages/cooking/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,63 @@
# cooking
[![npm](https://img.shields.io/npm/dm/cooking.svg?maxAge=2592000)]()
[![npm](https://img.shields.io/npm/v/cooking.svg?maxAge=6000)](https://www.npmjs.com/package/cooking)
[![gitter](https://img.shields.io/gitter/room/QingWei-Li/cooking.svg?maxAge=2592000)](https://gitter.im/QingWei-Li/cooking?utm_source=share-link&utm_medium=link&utm_campaign=share-link)

> 更易上手的前端构建工具,基于 webpack

## Links
- [Docs](http://cookingjs.github.io)
- [Examples](https://github.com/cooking-demo)
- [Plugins](https://github.com/cookingjs)

## Installation
```shell
npm i cooking -D
```

## webpack 1
### webpack 1
```shell
npm i babel-core babel-loader css-loader file-loader postcss postcss-loader\
html-loader html-webpack-plugin json-loader style-loader url-loader\
webpack@1 webpack-dev-server@1 extract-text-webpack-plugin@1 -D
```

## webpack 2
### webpack 2
```shell
npm i babel-core babel-loader css-loader file-loader postcss postcss-loader\
html-loader html-webpack-plugin json-loader style-loader url-loader\
webpack@beta webpack-dev-server@beta extract-text-webpack-plugin@beta -D
```

## Usage

cooking.conf.js
```javascript
var cooking = require('cooking')

cooking.set({
entry: './src/index.js',
dist: './dist',
template: './index.tpl',
hash: true,
extractCSS: true,
devServer: { port: 8080 }
})

module.exports = cooking.resolve()
```

```shell
# development
node_modules/.bin/cooking watch

# production
node_modules/.bin/cooking build -p

# or use webpack
NODE_ENV=production webpack --config cooking.conf.js
```

# License
[MIT](https://github.com/ElemeFE/cooking/LICENSE)

0 comments on commit 24f0434

Please sign in to comment.