Skip to content

Commit aa9e008

Browse files
authored
Merge pull request #3679 from swagger-api/shockey-readme-updates
README: npm module clarifications
2 parents aee5e75 + b43ac6d commit aa9e008

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010

1111
As a brand new version, written from the ground up, there are some known issues and unimplemented features. Check out the [Known Issues](#known-issues) section for more details.
1212

13-
This repo publishes to two different NPM packages:
13+
This repository publishes to two different NPM modules:
1414

15-
* [swagger-ui](https://www.npmjs.com/package/swagger-ui) is intended for use as a node module.
16-
* [swagger-ui-dist](https://www.npmjs.com/package/swagger-ui-dist) comes pre-bundled with all dependencies and can be incorporated directly in a webapp.
15+
* [swagger-ui](https://www.npmjs.com/package/swagger-ui) is a traditional npm module intended for use in JavaScript web application projects that are capable of resolving dependencies (via Webpack, Browserify, etc).
16+
* [swagger-ui-dist](https://www.npmjs.com/package/swagger-ui-dist) is a dependency-free module that includes everything you need to serve Swagger-UI in a server-side project, or a web project that can't resolve npm module dependencies.
1717

1818
For the older version of swagger-ui, refer to the [*2.x branch*](https://github.com/swagger-api/swagger-ui/tree/2.x).
1919

0 commit comments

Comments
 (0)