Skip to content

Commit

Permalink
docs: Add minimum supported Node.js version to README (#105)
Browse files Browse the repository at this point in the history
* docs: Add Node.js version badge to README
* docs: Add sematic-release badge to README
* docs: Add npm latest release badge to README
  • Loading branch information
chriswilty authored Sep 20, 2024
1 parent cd79db0 commit 590858a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
engine-strict=true
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Applause Button

[![Backers on Open Collective](https://opencollective.com/applause-button/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/applause-button/sponsors/badge.svg)](#sponsors)
[![Sponsors on Open Collective](https://opencollective.com/applause-button/sponsors/badge.svg)](#sponsors)
[![npm latest version](https://img.shields.io/npm/v/applause-button/latest.svg)](https://www.npmjs.com/package/applause-button)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

A zero-configuration button for adding applause / claps / kudos to web pages and blog-posts.

Expand All @@ -26,13 +29,16 @@ For more information, visit the [project website](https://colineberhardt.github.

## Development

![Node LTS](https://img.shields.io/node/v-lts/applause-button?logo=nodedotjs)

Clone this repo and install dependencies via yarn:

~~~
$ yarn
~~~

Use `yarn test` to run the test suite. These use Jest as the test runner, and Puppeteer as a headless Chrome instance, allowing the applause button to make API requests (with appropriate responses faked within the test code).
Use `yarn test` to run the test suite. These use Jest as the test runner, and Puppeteer as a headless Chrome instance,
allowing the applause button to make API requests (with appropriate responses faked within the test code).

You can build project and start watching the `src` folder for changes as follows:

Expand All @@ -43,14 +49,11 @@ $ yarn run watch
Run `yarn test:server` to start a dev server in another process.







### Releases

All releases are created automatically via [semantic release](https://github.com/semantic-release/semantic-release) running on Travis.
All releases are created automatically via
[semantic release](https://github.com/semantic-release/semantic-release)
running on Travis.


## Contributors
Expand All @@ -68,7 +71,8 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/applause-button#sponsor)]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
[[Become a sponsor](https://opencollective.com/applause-button#sponsor)]

<a href="https://opencollective.com/applause-button/sponsor/0/website" target="_blank"><img src="https://opencollective.com/applause-button/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/applause-button/sponsor/1/website" target="_blank"><img src="https://opencollective.com/applause-button/sponsor/1/avatar.svg"></a>
Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@
"jest": {
"preset": "jest-puppeteer"
},
"engines": {
"node": ">=18.17.0"
},
"browserslist": ["partially supports custom-elementsv1"],
"packageManager": "[email protected]"
}

0 comments on commit 590858a

Please sign in to comment.