Skip to content

Commit

Permalink
WIP Docs for 0.3.0 (#256)
Browse files Browse the repository at this point in the history
* adds updated recipes for webpack

* starting changelog

* more changelog changes

* even more changes

* add PR for webpack to changelog

* removes simple starter-kyt from recommendations

* Adding dates
  • Loading branch information
ccpricenytimes authored and delambo committed Oct 26, 2016
1 parent 73b33ed commit 529758c
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 14 deletions.
31 changes: 29 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,35 @@

## Master

## 0.2.2 (Sept 23, 2016)
## 0.3.0 (October 25, 2016)

### BREAKING CHANGES
- Upgrades Jest to version 16 [#259](https://github.com/NYTimes/kyt/pull/259)
See [Jest docs](http://facebook.github.io/jest/blog/2016/10/03/jest-16.html) for information on latest updates.

- Upgrades Webpack to v2.1.0-beta.25 [#264](https://github.com/NYTimes/kyt/pull/264)
Check the [recipes](/Recipes.md) to see the latest syntax for common extensions. Additional info in Webpack's [migration guide](https://webpack.js.org/how-to/upgrade-from-webpack-1/)

### FEATURES

- Adds serverless option to kyt [#174](https://github.com/NYTimes/kyt/pull/174)
See the new [static starter-kyt](https://github.com/nytimes/kyt-starter-static)

- Flags can now be passed through to internal tools [#230](https://github.com/NYTimes/kyt/pull/230)

- Adds multiple server entry handling [#247](https://github.com/NYTimes/kyt/pull/247)

- Default starter-kyt on setup is now the [universal starter-kyt](https://github.com/NYTimes/kyt-starter-universal) [#265](https://github.com/NYTimes/kyt/pull/265)

- Assets now use chunkhash [#239](https://github.com/NYTimes/kyt/pull/239)

- Make logs more readable [#190](https://github.com/NYTimes/kyt/pull/190)

- Displays Gzip size of assets [#244](https://github.com/NYTimes/kyt/pull/244)

- Adds end to end tests [#241](https://github.com/NYTimes/kyt/pull/241)

## 0.2.2 (Sept 30, 2016)

- Fixes linter `Configuration for rule "eol-last" is invalid` ESLint bug by upgrading all of the linter dependencies.

Expand Down Expand Up @@ -37,4 +65,3 @@ kyt adds these linter files to your project on setup. These files now reference
## 0.1.0 (Sept 12, 2016)

* Initial public release

13 changes: 9 additions & 4 deletions docs/Recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,13 @@ in `kyt.config.js`
```javascript
modifyWebpackConfig: (baseConfig, options) => {

baseConfig.postcss.push(
require('precss')()
baseConfig.plugins.push(
new webpack.LoaderOptionsPlugin({
options: {
postcss: [require('postcss-cssnext')],
context: '/',
},
})
);

return baseConfig;
Expand All @@ -55,8 +60,8 @@ in kyt.config.js
```javascript
modifyWebpackConfig: (baseConfig, options) => {

const babelLoader = baseConfig.module.loaders.find(loader => loader.loader === 'babel-loader');
babelLoader.query.plugins.push(path.resolve('./path/to/my/plugin'));
const babelLoader = baseConfig.module.rules.find(loader => loader.loader === 'babel-loader');
babelLoader.options.plugins.push(path.resolve('./path/to/my/plugin'));

return baseConfig;
}
Expand Down
19 changes: 11 additions & 8 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ If kyt finds any files with duplicate names, it will back up your file before re

`setup` also allows you to plug a starter-kyt into your app.

Running `kyt setup` will give you the option to install the default starter-kyt.
Running `kyt setup` will give you the option to install the [default starter-kyt.](https://github.com/NYTimes/kyt-starter-universal)

You can also pass the `-r` flag with any starter-kyt git clone URL:

```
kyt setup -r git@github.com:nytimes/kyt-starter-universal.git
kyt setup -r git@github.com:nytimes/kyt-starter.git
```

`setup` will then:
Expand All @@ -53,16 +53,19 @@ You can also pass the `-r` flag with any starter-kyt git clone URL:

### Recommended starter-kyts

#### [Default starter-kyt](https://github.com/nytm/wf-kyt-starter)
#### [Universal React starter-kyt](https://github.com/NYTimes/kyt-starter-universal)
This default starter-kyt is a good base for building advanced, universal React apps.

The default starter-kyt is for building simple React apps.
Install by running: `node_modules/.bin/kyt setup`
```
node_modules/.bin/kyt setup
```

#### [Universal React starter-kyt](https://github.com/nytm/wf-kyt-starter-universal)
This starter-kyt is a good base for building advanced, universal React apps.
#### [Static starter-kyt](https://github.com/NYTimes/kyt-starter-static)

This starter-kyt is for creating client side React apps.
Install by running:
```
node_modules/.bin/kyt setup -r git@github.com:nytimes/kyt-starter-universal.git
node_modules/.bin/kyt setup -r git@github.com:nytimes/kyt-starter-static.git
```

#### [Universal Angular2 starter-kyt](https://github.com/delambo/kyt-starter-universal-angular2)
Expand Down

0 comments on commit 529758c

Please sign in to comment.