Skip to content

Commit

Permalink
Merge pull request #319 from johnnyreilly/master
Browse files Browse the repository at this point in the history
rejig README.md
  • Loading branch information
johnnyreilly authored Oct 16, 2016
2 parents 8de8997 + 43b880a commit 11641b6
Showing 1 changed file with 29 additions and 15 deletions.
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,35 @@

# TypeScript loader for webpack

This is the typescript loader for webpack.

## Getting Started

Tutorials and examples can be [found here](https://github.com/TypeStrong/ts-loader/wiki/Tutorials-&-Examples).

### Compatibility

ts-loader supports the latest and greatest version of TypeScript right back to v1.6. (Including the [nightly build](http://blogs.msdn.com/b/typescript/archive/2015/07/27/introducing-typescript-nightlies.aspx).)

A full test suite runs against the following versions of TypeScript each night (and on each pull request):
- TypeScript 2.0
- TypeScript 1.8
- TypeScript 1.7
- TypeScript 1.6

and also:
- TypeScript@next (because we want to use it as much as you do)

If you become aware of issues not caught by the test suite then please let us know.

### Babel

ts-loader works very well in combination with [babel](https://babeljs.io/) and [babel-loader](https://github.com/babel/babel-loader). To see an example of this in practice take a look at the [example](https://github.com/Microsoft/TypeScriptSamples/tree/master/react-flux-babel-karma) in the official [TypeScript Samples](https://github.com/Microsoft/TypeScriptSamples).

### Contributing

This is your TypeScript loader! We want you to help make it even better. Please feel free to contribute; see the [contributer's guide](CONTRIBUTING.md) to get started.

### Installation

```
Expand All @@ -28,22 +53,11 @@ npm install typescript -g
npm link typescript
```

### Upgrading

Take advantage of the [Changelog](CHANGELOG.md) and [Upgrade Guide](UPGRADE.md).

### Running

Use webpack like normal, including `webpack --watch` and `webpack-dev-server`, or through another
build system using the [Node.js API](http://webpack.github.io/docs/node.js-api.html).

### Compatibility

The current version is compatible with TypeScript 1.6 and above, including the [nightly build](http://blogs.msdn.com/b/typescript/archive/2015/07/27/introducing-typescript-nightlies.aspx).
You may experience issues using the nightly build due to its nature, but a full test suite runs
against the latest nightly every day to catch incompatibilites early. Please report any issues
you experience with the nightly so that they can be fixed promptly.

### Configuration

1. Create or update `webpack.config.js` like so:
Expand Down Expand Up @@ -91,6 +105,10 @@ When the build fails (i.e. at least one typescript compile error occured), ts-lo

For more background have a read of [this issue](https://github.com/TypeStrong/ts-loader/issues/108).

### Upgrading

Take advantage of the [Changelog](CHANGELOG.md) and [Upgrade Guide](UPGRADE.md).

#### Options

There are two types of options: TypeScript options (aka "compiler options") and loader options.
Expand Down Expand Up @@ -174,10 +192,6 @@ The same basic process is required for code splitting. In this case, you `import
don't directly use them. Instead you require them at [split points](http://webpack.github.io/docs/code-splitting.html#defining-a-split-point).
See [this example](test/codeSplitting) for more details.
## Contributing
Please see the [contributer's guide](CONTRIBUTING.md).

## License
MIT License
Expand Down

0 comments on commit 11641b6

Please sign in to comment.