Skip to content

Commit cac3c87

Browse files
committed
docs(readme): updates for JSF maintainers
1 parent 1867023 commit cac3c87

File tree

1 file changed

+63
-10
lines changed

1 file changed

+63
-10
lines changed

README.md

Lines changed: 63 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
1-
# imports loader for webpack
2-
3-
The imports loader allows you to use modules that depend on specific global variables.
1+
[![npm][npm]][npm-url]
2+
[![deps][deps]][deps-url]
3+
[![test][test]][test-url]
4+
[![chat][chat]][chat-url]
5+
6+
<div align="center">
7+
<!-- replace with accurate logo e.g from https://worldvectorlogo.com/ -->
8+
<a href="https://github.com/webpack/webpack">
9+
<img width="200" height="200" vspace="" hspace="25"
10+
src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
11+
</a>
12+
<h1>Imports Loader</h1>
13+
<p>The imports loader allows you to use modules that depend on specific global variables.<p>
14+
</div>
415

516
This is useful for third-party modules that rely on global variables like `$` or `this` being the `window` object. The imports loader can add the necessary `require('whatever')` calls, so those modules work with webpack.
617

7-
## Installation
18+
<h2 align="center">Install</h2>
819

9-
```
20+
```bash
1021
npm install imports-loader
1122
```
1223

13-
## Usage
24+
<h2 align="center">Usage</h2>
1425

1526
Given you have this file `example.js`
1627

@@ -66,7 +77,7 @@ module.exports = {
6677

6778
[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html)
6879

69-
## Typical use-cases
80+
<h2 align="center">Typical Use Cases</h2>
7081

7182
### jQuery plugins
7283

@@ -88,6 +99,48 @@ imports-loader?define=>false
8899
89100
For further hints on compatibility issues, check out [Shimming Modules](http://webpack.github.io/docs/shimming-modules.html) of the official docs.
90101
91-
## License
92-
93-
MIT (http://www.opensource.org/licenses/mit-license.php)
102+
<h2 align="center">Maintainers</h2>
103+
104+
<table>
105+
<tbody>
106+
<tr>
107+
<td align="center">
108+
<img width="150" height="150"
109+
src="https://avatars3.githubusercontent.com/u/166921?v=3&s=150">
110+
</br>
111+
<a href="https://github.com/bebraw">Juho Vepsäläinen</a>
112+
</td>
113+
<td align="center">
114+
<img width="150" height="150"
115+
src="https://avatars2.githubusercontent.com/u/8420490?v=3&s=150">
116+
</br>
117+
<a href="https://github.com/d3viant0ne">Joshua Wiens</a>
118+
</td>
119+
<td align="center">
120+
<img width="150" height="150"
121+
src="https://avatars3.githubusercontent.com/u/533616?v=3&s=150">
122+
</br>
123+
<a href="https://github.com/SpaceK33z">Kees Kluskens</a>
124+
</td>
125+
<td align="center">
126+
<img width="150" height="150"
127+
src="https://avatars3.githubusercontent.com/u/3408176?v=3&s=150">
128+
</br>
129+
<a href="https://github.com/TheLarkInn">Sean Larkin</a>
130+
</td>
131+
</tr>
132+
<tbody>
133+
</table>
134+
135+
136+
[npm]: https://img.shields.io/npm/v/imports-loader.svg
137+
[npm-url]: https://npmjs.com/package/imports-loader
138+
139+
[deps]: https://david-dm.org/webpack-contrib/imports-loader.svg
140+
[deps-url]: https://david-dm.org/webpack-contrib/imports-loader
141+
142+
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
143+
[chat-url]: https://gitter.im/webpack/webpack
144+
145+
[test]: http://img.shields.io/travis/webpack-contrib/imports-loader.svg
146+
[test-url]: https://travis-ci.org/webpack-contrib/imports-loader

0 commit comments

Comments
 (0)