Skip to content

Commit

Permalink
4.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hegemonic committed Nov 3, 2022
1 parent b018408 commit 0842185
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 17 deletions.
14 changes: 12 additions & 2 deletions CHANGES.md
@@ -1,6 +1,16 @@
# JSDoc 3 change history
# JSDoc change history

This file describes notable changes in each version of JSDoc 3.
This file describes notable changes in each version of JSDoc, starting with version 3.0.0.


## 4.0.0 (November 2022)

+ JSDoc releases now use [semantic versioning](https://semver.org/). If JSDoc makes
backwards-incompatible changes in the future, the major version will be incremented.
+ JSDoc no longer uses the [`taffydb`](https://taffydb.com/) package. If your JSDoc template or
plugin uses the `taffydb` package, see the
[instructions for replacing `taffydb` with `@jsdoc/salty`](https://github.com/jsdoc/jsdoc/tree/main/packages/jsdoc-salty#use-salty-in-a-jsdoc-template).
+ JSDoc now supports Node.js 12.0.0 and later.


## 3.6.11 (July 2022)
Expand Down
15 changes: 4 additions & 11 deletions README.md
Expand Up @@ -22,13 +22,6 @@ To install the latest version on npm locally and save it in your package's

npm install --save-dev jsdoc

**Note**: By default, npm adds your package using the caret operator in front of
the version number (for example, `^3.6.3`). We recommend using the tilde
operator instead (for example, `~3.6.3`), which limits updates to the most
recent patch-level version. See
[this Stack Overflow answer](https://stackoverflow.com/questions/22343224) for
more information about the caret and tilde operators.

To install the latest development version locally, without updating your
project's `package.json` file:

Expand Down Expand Up @@ -93,8 +86,8 @@ JSDoc](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3)

## License

JSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and
the [contributors to JSDoc](https://github.com/jsdoc/jsdoc/graphs/contributors).
JSDoc is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the
[contributors to JSDoc](https://github.com/jsdoc/jsdoc/graphs/contributors).

JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See
the file `LICENSE.md` in this distribution for more details.
JSDoc is free software, licensed under the Apache License, Version 2.0. See the
file `LICENSE.md` in this distribution for more details.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
@@ -1,7 +1,7 @@
{
"name": "jsdoc",
"version": "3.6.11",
"revision": "1658338843387",
"version": "4.0.0",
"revision": "1667500635552",
"description": "An API documentation generator for JavaScript.",
"keywords": [
"documentation",
Expand Down

0 comments on commit 0842185

Please sign in to comment.