Skip to content

Commit f3350a6

Browse files
authored
Merge pull request #1 from muescha/patch-1
update README
2 parents 4716939 + 2165595 commit f3350a6

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gatsby-transformer-gitinfo
22

3-
Add some git information on `File` fields: latest commit date, author and email.
3+
Add some git information on `File` fields from latest commit: date, author and email.
44

55
## Install
66

@@ -16,22 +16,22 @@ In your `gatsby-config.js`
1616
```javascript
1717
module.exports = {
1818
plugins: [
19-
`gatsby-transformer-gitinfo`,
2019
{
2120
resolve: `gatsby-source-filesystem`,
2221
options: {
2322
path: `./src/data/`,
2423
},
2524
},
25+
`gatsby-transformer-gitinfo`,
2626
],
2727
}
2828
```
2929

3030
Where the _source folder_ `./src/data/` is a git versionned directory.
3131

32-
The plugin will add three fields to `File` nodes: `gitDate`, `gitAuthorName` and `gitAuthorEmail`. These fields are relative to the latest commit touching that file.
32+
The plugin will add three fields to `File` nodes: `gitDate`, `gitAuthorName` and `gitAuthorEmail`. These fields are related to the latest commit touching that file.
3333

34-
If the file is not versionned, these feilds will be `null`.
34+
If the file is not versionned, these fields will be `null`.
3535

3636
They are exposed in your graphql schema which you can query:
3737

@@ -57,7 +57,7 @@ query {
5757
}
5858
```
5959

60-
Now you have a File node to work with:
60+
Now you have a `File` node to work with:
6161

6262
```json
6363
{
@@ -125,6 +125,7 @@ module.exports = {
125125
}
126126
```
127127

128+
## Example
128129

129130
Note: the execution order is first whitelist, then blacklist.
130131

@@ -140,4 +141,4 @@ module.exports = {
140141
},
141142
],
142143
}
143-
```
144+
```

0 commit comments

Comments
 (0)