Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAMathews authored Apr 5, 2018
1 parent 21a6570 commit 60b3d2d
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions packages/gatsby-transformer-excel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,29 @@ Parses Excel files into JSON arrays.

`npm install --save gatsby-transformer-excel`

> Note: You will also need to use the [`gatsby-source-filesystem`](https://www.gatsbyjs.org/packages/gatsby-source-filesystem/) plugin to
make it works. You will have to point the path of the directory of your excel
files.

`npm install --save gatsby-source-filesystem`
Note: You generally will use this plugin together with the [`gatsby-source-filesystem`](/packages/gatsby-source-filesystem/) plugin. `gatsby-source-filesystem` reads in the files then this plugin *transforms* the files into data you can query.

## How to use

If you put your Excel's files in `./src/data`:

```javascript
// In your gatsby-config.js
plugins: [
{
resolve: `gatsby-source-filesystem`,
options: {
name: `data`,
path: `${__dirname}/src/data/`,
module.exports = {
plugins: [
{
resolve: `gatsby-source-filesystem`,
options: {
name: `data`,
path: `${__dirname}/src/data/`,
},
},
},
`gatsby-transformer-excel`,
];
`gatsby-transformer-excel`,
],
}
```

You can see an example project on the official [Gatsby repository](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-excel).
You can see an example project at https://github.com/gatsbyjs/gatsby/tree/master/examples/using-excel.

## Parsing algorithm

Expand Down

0 comments on commit 60b3d2d

Please sign in to comment.