Skip to content

Commit

Permalink
Update status + add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
martpie committed Jul 24, 2023
1 parent de71b78 commit 44d3ca1
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
> **Note**
> All `next-transpile-modules` features have natively landed to Next.js 13.1, you can check [the migration guide here](https://github.com/martpie/next-transpile-modules/releases/tag/the-end).
>
> This package is now officially deprecated, and the repository will be archived soon, thank you everyone!
> All `next-transpile-modules` features have natively landed to Next.js 13.1, you can check [the migration guide here](https://github.com/martpie/next-transpile-modules/releases/tag/the-end).
>
> This package is now officially deprecated and on life-support.
>
> PRs with fixes are welcome and I will help review them, but that's it. I **highly** recommend contributing to Next.js in case your setup is not working there.
---

Expand Down Expand Up @@ -41,7 +43,7 @@ What this plugin **does not aim** to solve:
| Next.js 8 / 9 | 2.x |
| Next.js 6 / 7 | 1.x |

Last Next.js version tested: **13.0.4**.
Latest Next.js version tested: **13.4.12**.

## Installation

Expand Down Expand Up @@ -202,6 +204,21 @@ export default function MyApp({ Component, pageProps }) {
}
```

## Contributing

- clone
- `cd next-transpile-modules`
- `yarn`

If you want to update the Next.js tested version:

- update `scripts/next-update.sh` with the latest Next.js version
- make sure `npm`, `yarn` and `pnpm` are installed
- `yarn setup`
- `bash scripts/next-update.sh`

Push your changes and Github Actions will test everything as it should be.

## FAQ

### What is the difference with `@weco/next-plugin-transpile-modules`?
Expand Down

0 comments on commit 44d3ca1

Please sign in to comment.