Skip to content

Commit

Permalink
docs: switch default to main
Browse files Browse the repository at this point in the history
  • Loading branch information
staylor committed Apr 26, 2021
1 parent 878678f commit c431909
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .drone.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ local steps = [
{
kind: "pipeline",
type: "docker",
name: "kyt_master_push",
name: "kyt_main_push",
trigger: {
branch: ["master"],
branch: ["main"],
event: ["push"]
},

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Every sizable JavaScript web app needs a common foundation: a setup to build, ru

Read more about kyt in our [blog post](http://open.blogs.nytimes.com/2016/09/13/introducing-kyt-our-web-app-configuration-toolkit/).

[![Build Status](https://travis-ci.org/nytimes/kyt.svg?branch=master)](https://travis-ci.org/nytimes/kyt) [![Dependency Status](https://david-dm.org/NYTimes/kyt.svg)](https://david-dm.org/NYTimes/kyt) [![npm](https://img.shields.io/npm/v/kyt.svg)](https://www.npmjs.com/package/kyt)
[![Build Status](https://travis-ci.org/nytimes/kyt.svg?branch=main)](https://travis-ci.org/nytimes/kyt) [![Dependency Status](https://david-dm.org/NYTimes/kyt.svg)](https://david-dm.org/NYTimes/kyt) [![npm](https://img.shields.io/npm/v/kyt.svg)](https://www.npmjs.com/package/kyt)

## Quick Start

Expand Down
2 changes: 1 addition & 1 deletion docs/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ After a `build`, `kyt` produces the following client bundles (with their corresp
- `runtime~main.js` - A mapping of chunk names.
- `vendor.js` - Common/shared modules between the bundles and chunks.

To keep each version of an asset unique, `kyt` will output the client assets with a hash in the name (e.g.: `main-34a8b999.js`) `kyt` also exports a `publicAssets.json` file that can be referenced using the `KYT.ASSETS_MANIFEST` environment variable. In your project, you should import the asset manifest file, get the hashed asset names and load the client assets through `<script>` tags. If you based your project on a starter kyt, then you already have this code in place in the `src/server/index.js`/`src/server/template.js`. If not, [check out the following lines](https://github.com/NYTimes/kyt/blob/master/packages/kyt-starter-universal/starter-src/src/server/index.js#L40-L43) for how you import the asset manifest and reference the assets. Note that the JavaScript assets need to be loaded in the following order:
To keep each version of an asset unique, `kyt` will output the client assets with a hash in the name (e.g.: `main-34a8b999.js`) `kyt` also exports a `publicAssets.json` file that can be referenced using the `KYT.ASSETS_MANIFEST` environment variable. In your project, you should import the asset manifest file, get the hashed asset names and load the client assets through `<script>` tags. If you based your project on a starter kyt, then you already have this code in place in the `src/server/index.js`/`src/server/template.js`. If not, [check out the following lines](https://github.com/NYTimes/kyt/blob/main/packages/kyt-starter-universal/starter-src/src/server/index.js#L40-L43) for how you import the asset manifest and reference the assets. Note that the JavaScript assets need to be loaded in the following order:

- `runtime~main.js`
- `vendor.js`
Expand Down
4 changes: 2 additions & 2 deletions packages/babel-preset-kyt-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A wrapper around [`@babel/preset-react`](https://babeljs.io/docs/en/babel-preset-react) with optional production enhancements.

This preset includes [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/master/packages/babel-preset-kyt-core) - you do not need to install both.
This preset includes [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/main/packages/babel-preset-kyt-core) - you do not need to install both.

- Automatically strips `propTypes` when `(NODE|BABEL)_ENV=production`.
- Properly passes `{ development: true }` to [`@babel/preset-react`](https://babeljs.io/docs/en/babel-preset-react) when `(NODE|BABEL)_ENV=development`.
Expand All @@ -23,6 +23,6 @@ $ npm i --save-dev --save-exact babel-preset-kyt-react
- [`@babel/plugin-transform-react-constant-elements`](https://babeljs.io/docs/en/babel-plugin-transform-react-constant-elements)
- [`@babel/plugin-transform-react-inline-elements`](https://babeljs.io/docs/en/babel-plugin-transform-react-inline-elements)

- `envOptions` (`Object`) - passed down to [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/master/packages/babel-preset-kyt-core). [See more](/packages/babel-preset-kyt-core/README.md#options).
- `envOptions` (`Object`) - passed down to [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/main/packages/babel-preset-kyt-core). [See more](/packages/babel-preset-kyt-core/README.md#options).

- `includeRuntime` (`Boolean`) - whether or not to include [`@babel/plugin-transform-runtime`](https://babeljs.io/docs/en/babel-plugin-transform-runtime); default: `false`
4 changes: 2 additions & 2 deletions packages/babel-preset-kyt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Omnibus `kyt` Babel configuration with TypeScript support.

This preset includes [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/master/packages/babel-preset-kyt-core) and [`babel-preset-kyt-react`](https://github.com/nytimes/kyt/tree/master/packages/babel-preset-kyt-react) - you do not need to install them.
This preset includes [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/main/packages/babel-preset-kyt-core) and [`babel-preset-kyt-react`](https://github.com/nytimes/kyt/tree/main/packages/babel-preset-kyt-react) - you do not need to install them.

- Automatically strips `propTypes` when `(NODE|BABEL)_ENV=production`.
- Properly passes `{ development: true }` to [`@babel/preset-react`](https://babeljs.io/docs/en/babel-preset-react) when `(NODE|BABEL)_ENV=development`.
Expand All @@ -23,6 +23,6 @@ $ npm i --save-dev --save-exact babel-preset-kyt
- [`@babel/plugin-transform-react-constant-elements`](https://babeljs.io/docs/en/babel-plugin-transform-react-constant-elements)
- [`@babel/plugin-transform-react-inline-elements`](https://babeljs.io/docs/en/babel-plugin-transform-react-inline-elements)

- `envOptions` (`Object`) - passed down to [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/master/packages/babel-preset-kyt-core). [See more](/packages/babel-preset-kyt-core/README.md#options).
- `envOptions` (`Object`) - passed down to [`babel-preset-kyt-core`](https://github.com/nytimes/kyt/tree/main/packages/babel-preset-kyt-core). [See more](/packages/babel-preset-kyt-core/README.md#options).

- `includeRuntime` (`Boolean`) - whether or not to include [`@babel/plugin-transform-runtime`](https://babeljs.io/docs/en/babel-plugin-transform-runtime); default: `false`
2 changes: 1 addition & 1 deletion packages/kyt-starter-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The following are some of the tools included in this `starter-kyt`:
## How To Contribute

Want to build your own `starter-kyt`?
See directions [here](https://github.com/NYTimes/kyt/blob/master/docs/Starterkyts.md).
See directions [here](https://github.com/NYTimes/kyt/blob/main/docs/Starterkyts.md).
2 changes: 1 addition & 1 deletion packages/kyt-starter-universal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The following are some of the tools included in this `starter-kyt`:
## How To Contribute

Want to build your own `starter-kyt`?
See directions [here](https://github.com/NYTimes/kyt/blob/master/docs/Starterkyts.md).
See directions [here](https://github.com/NYTimes/kyt/blob/main/docs/Starterkyts.md).

0 comments on commit c431909

Please sign in to comment.