Skip to content

Commit

Permalink
Bump version to 2.0.0 and add note about module compatibility
Browse files Browse the repository at this point in the history
- Bump version to `2.0.0`.
- Add note about ESM compatibility in README.md file.
- Remove dollar sign used before commands without showing output, refer to https://github.com/markdownlint/markdownlint/blob/v0.13.0/docs/RULES.md#md014---dollar-signs-used-before-commands-without-showing-output

⚠ BREAKING CHANGE: Package is now ESM-only.
For CJS compatibility to switch to the `1.x` version.
  • Loading branch information
huiyifyj committed Jan 19, 2025
1 parent 8c5ab9f commit dfd6656
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,14 @@
Via npm :

```bash
$ npm i @xn-02f/gravatar
npm i @xn-02f/gravatar
```

> [!NOTE]
> This library was moved to ESM from `v2`.
>
> If ESM doesn't work well with your node version, switch to the `1.x` version for CJS compatibility.
## Usage

```javascript
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@xn-02f/gravatar",
"version": "1.3.3",
"version": "2.0.0",
"description": "A library to generate gravatar image url.",
"type": "module",
"exports": "./gravatar.js",
Expand Down

0 comments on commit dfd6656

Please sign in to comment.