Skip to content

Commit

Permalink
README improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
andys8 committed Aug 7, 2020
1 parent e773515 commit 141ac8c
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,31 @@

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

This is a [craco](https://github.com/gsoft-inc/craco) plugin to add [purs-loader](https://www.npmjs.com/package/purs-loader) for [PureScript](https://www.purescript.org) with [`create-react-app`](https://facebook.github.io/create-react-app). It allows you to use PureScript code in `create-react-app` without ejecting.
This is a [craco](https://github.com/gsoft-inc/craco) plugin to add [purs-loader](https://www.npmjs.com/package/purs-loader) with [`create-react-app`](https://facebook.github.io/create-react-app).

It allows you to use [PureScript](https://www.purescript.org) code in `create-react-app` without ejecting.

## Installation

```shell
```bash
npm install craco-purescript-loader --save-dev
```

or

```shell
# or
yarn add -D craco-purescript-loader
```

## Usage

```js
const cracoPureScriptLoader = require("craco-purescript-loader");

module.exports = {
plugins: [{ plugin: cracoPureScriptLoader }],
};
```

`craco-purescript-loader` expect a `options` to overwrite `purs-loader` options.
See <https://www.npmjs.com/package/purs-loader#options>
### Overwrite Options

`craco-purescript-loader` configuration `options` will overwrite [`purs-loader` options](https://www.npmjs.com/package/purs-loader#options).

```js
const cracoPureScriptLoader = require("craco-purescript-loader");
Expand Down

0 comments on commit 141ac8c

Please sign in to comment.