Skip to content

Commit 94d2d7a

Browse files
committed
chore: update readme
Signed-off-by: Charlike Mike Reagent <[email protected]>
1 parent c87216b commit 94d2d7a

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@
1313
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
1414
[![Twitter][twitter-img]][twitter-url]
1515

16-
## Status: Maintained
16+
## Status: Maintained [![npm version][npmv-canary-img]][npmv-url] [![npm version][npmv-dev-img]][npmv-url]
1717

1818
This module was initially developed by [**@felixge**](https://github.com/felixge) for [Transloadit](http://transloadit.com/), a service focused on uploading and encoding images and videos. It has been battle-tested against hundreds of GBs of file uploads from a large variety of clients and is considered production-ready and is used in production for years.
1919

2020
Currently, we are few maintainers trying to deal with it. :) More contributors are always welcome! :heart:
2121
Jump on [issue #412](https://github.com/felixge/node-formidable/issues/412) if you are interested.
2222

23-
_**Note:** Master is a "development" branch - try it with `npm i formidable@canary`.
23+
_**Note:** Master is a "canary" branch - try it with `npm i formidable@canary`.
2424
Do not expect (for now) things from it to be inside the`latest`"dist-tag" in the Npm.
2525
The`formidable@latest`is the`v1.2.1` version and probably it will be the last`v1` release!_
2626

2727
_**Note: v2 is coming soon!**_
2828

29-
[![npm version][npmv-canary-img]][npmv-url]
29+
You can try the [Plugins API](https://github.com/felixge/node-formidable/tree/plugins-api)
30+
([#545](https://github.com/felixge/node-formidable/pull/545)),
31+
which is available through `formidable@dev`.
3032

3133
## Highlights
3234

@@ -40,15 +42,15 @@ _**Note: v2 is coming soon!**_
4042

4143
```sh
4244
npm install formidable
43-
# or the development version
45+
# or the canary version
4446
npm install formidable@canary
4547
```
4648

4749
or with Yarn v1/v2
4850

4951
```sh
5052
yarn add formidable
51-
# or the development version
53+
# or the canary version
5254
yarn add formidable@canary
5355
```
5456

@@ -420,6 +422,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
420422

421423
<!-- markdownlint-enable -->
422424
<!-- prettier-ignore-end -->
425+
423426
<!-- ALL-CONTRIBUTORS-LIST:END -->
424427

425428
## License
@@ -435,6 +438,7 @@ Formidable is licensed under the [MIT License][license-url].
435438
[build-img]: https://badgen.net/github/checks/node-formidable/node-formidable?label=build&icon=github
436439
[build-url]: https://github.com/node-formidable/node-formidable/actions?query=workflow%3Anodejs
437440
[npmv-canary-img]: https://badgen.net/npm/v/formidable/canary?icon=npm
441+
[npmv-dev-img]: https://badgen.net/npm/v/formidable/dev?icon=npm
438442
[npmv-img]: https://badgen.net/npm/v/formidable?icon=npm
439443
[npmv-url]: https://npmjs.com/package/formidable
440444
[license-img]: https://badgen.net/npm/license/formidable

0 commit comments

Comments
 (0)