Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: set npm version and recommend corepack #25

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:
- uses: actions/setup-node@v2
with:
node-version: '14'
node-version-file: 'package.json'

- uses: actions/checkout@v2
- run: |
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@

Break screen channels for displaying and reacting to donations and donation totals during mainline Games Done Quick and Frame Fatales broadcasts.

It is recommended to use `corepack` if it's available in your Node.js installation.

- Check if it is available with `corepack --version`
- Enable it with `corepack enable npm yarn pnpm`.

## Requirements

- Node v14
- [email protected]

While other Node versions may work for this project, we use and deploy against Node v14 due to some dependencies of our current layout system (Pratchett).

Expand Down Expand Up @@ -40,4 +46,4 @@ Designed & developed by [Support Class](https://supportclass.net)

- [Chris Hanel](https://twitter.com/ChrisHanel)
- [Dillon Pentz](https://twitter.com/Dillon_Pentz)
- [Melanie Arnold](https://github.com/einalem4)
- [Melanie Arnold](https://github.com/einalem4)
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
"description": "Donation Total Channels for GDQ Broadcasts",
"author": "",
"license": "Apache-2.0",
"packageManager": "[email protected]",
"engines": {
"node": "^14.19.0",
"npm": "6"
},
"files": [
"src/",
"tsconfig.json"
Expand Down