Skip to content
This repository was archived by the owner on Jan 2, 2022. It is now read-only.

Commit 6b9a6e5

Browse files
committed
docs(readme): update readme for this repo
Signed-off-by: Jonah Snider <[email protected]>
1 parent 28cea28 commit 6b9a6e5

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

readme.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1-
# [TypeScript](https://www.typescriptlang.org) Starter
1+
# Netlify Next.js cache
22

33
[![Build Status](https://github.com/pizzafox/netlify-cache-nextjs/workflows/CI/badge.svg)](https://github.com/pizzafox/netlify-cache-nextjs/actions)
44
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
5-
[![codecov](https://codecov.io/gh/pizzafox/netlify-cache-nextjs/branch/master/graph/badge.svg)](https://codecov.io/gh/pizzafox/netlify-cache-nextjs)
65

76
Cache the `.next` folder in Netlify builds.
7+
A [Netlify plugin](https://www.netlify.com/build/plugins-beta/).
88

9-
## Prequisites
9+
## Usage
10+
11+
This is a Netlify plugin, which will run during your Netlify builds.
12+
As of now, Netlify plugins are in closed beta.
13+
You can learn more about them, and apply for the beta [here](https://www.netlify.com/build/plugins-beta/).
14+
15+
## Contributing
16+
17+
### Prequisites
1018

1119
This project uses [Node.js](https://nodejs.org) 12 to run.
1220

@@ -18,12 +26,12 @@ yarn install
1826
# or `pnpm install`
1927
```
2028

21-
## Building
29+
### Building
2230

2331
Run the `build` script to compile the TypeScript into the `tsc_output` folder.
2432
This will compile the `src` and the `test` directory, so be careful not to upload the whole folder as a published package.
2533

26-
## Style
34+
### Style
2735

2836
This project uses [Prettier](https://prettier.io) and [XO](https://github.com/xojs/xo).
2937

@@ -41,7 +49,7 @@ yarn run lint
4149

4250
Note that XO will also error if you have TypeScript errors, not just if your formatting is incorrect.
4351

44-
## Linting
52+
### Linting
4553

4654
This project uses [XO](https://github.com/xojs/xo) (which uses [ESLint](https://eslint.org) and some plugins internally) to perform static analysis on the TypeScript.
4755
It reports things like unused variables or not following code conventions.
@@ -51,17 +59,3 @@ yarn run lint
5159
```
5260

5361
Note that XO will also error if you have incorrect formatting, not just if your TypeScript code has errors.
54-
55-
## Testing
56-
57-
Unit tests are in the `test` folder.
58-
You can run the tests with the `test` script:
59-
60-
```sh
61-
yarn run test
62-
```
63-
64-
### Coverage
65-
66-
This will generate a `coverage` folder which has a breakdown of coverage of the project.
67-
The CI will upload the coverage information to [CodeCov](https://codecov.io) which can be [viewed here](https://codecov.io/gh/pizzafox/netlify-cache-nextjs).

0 commit comments

Comments
 (0)