Browse Source

add version badges

plugin-mode
gasolin 8 years ago
parent
commit
4d44b855f6
  1. 13
      packages/neutrino-preset-base/README.md
  2. 16
      packages/neutrino-preset-react/README.md
  3. 14
      packages/neutrino-preset-web/README.md

13
packages/neutrino-preset-base/README.md

@ -1,4 +1,4 @@
# Neutrino Base Preset
# Neutrino Base Preset [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
This [neutrino](https://github.com/mozilla-neutrino/neutrino) preset is abstract and should not be
used directly to build a JavaScript project. Rather, this preset contains shared configuration that
@ -6,3 +6,14 @@ is extended by all other core neutrino presets.
Modify this preset if there is shared configuration that should be propagated to all other core
neutrino presets. This preset contains the bulk of the shared Webpack and ESLint configuration.
# Technology
* [neutrino-preset-base](https://github.com/mozilla-neutrino/neutrino-preset-base)
* babel-preset-es2015: Polyfill ES2015 syntaxes
[npm-image]: https://badge.fury.io/js/neutrino-preset-base.svg
[npm-url]: https://npmjs.org/package/neutrino-preset-base
[daviddm-image]: https://david-dm.org/mozilla-neutrino/neutrino-preset-base.svg
[daviddm-url]: https://david-dm.org/mozilla-neutrino/neutrino-preset-base

16
packages/neutrino-preset-react/README.md

@ -1,4 +1,4 @@
# Neutrino React Preset
# Neutrino React Preset [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
This [neutrino](https://github.com/mozilla-neutrino/neutrino) preset enables building JSX-supported
React-based web applications with a common configuration for Webpack, ESLint, Babel, Karma+Mocha,
@ -94,3 +94,17 @@ You can also choose to load different presets for different targets if you so wi
By default, HTML files are built using the `template.ejs` from the [neutrino-preset-web preset](https://github.com/mozilla-neutrino/neutrino-preset-web).
If you wish to use a custom template or if the default just doesn't suit your needs, you can create
a `template.ejs` file in your `src/` directory, and it will be picked up automatically.
# Technology
* [neutrino-preset-base](https://github.com/mozilla-neutrino/neutrino-dev/tree/master/packages/neutrino-preset-base)
* [neutrino-preset-web](https://github.com/mozilla-neutrino/neutrino-dev/tree/master/packages/neutrino-preset-web)
* babel-preset-react
* eslint-plugin-react
* react-hot-loader
[npm-image]: https://badge.fury.io/js/neutrino-preset-react.svg
[npm-url]: https://npmjs.org/package/neutrino-preset-react
[daviddm-image]: https://david-dm.org/mozilla-neutrino/neutrino-preset-react.svg
[daviddm-url]: https://david-dm.org/mozilla-neutrino/neutrino-preset-react

14
packages/neutrino-preset-web/README.md

@ -1,4 +1,4 @@
# Neutrino Web Preset
# Neutrino Web Preset [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
This [neutrino](https://github.com/mozilla-neutrino/neutrino) preset enables building generic web
applications with a common configuration for Webpack, ESLint, Babel, Karma+Mocha, along with a
@ -94,3 +94,15 @@ You can also choose to load different presets for different targets if you so wi
By default, HTML files are built using the template located in `src/template.ejs` in this repo. If
you wish to use a custom template or if the default just doesn't suit your needs, you can create a
`template.ejs` file in your `src/` directory, and this preset will pick it up automatically.
# Technology
* [neutrino-preset-base](https://www.npmjs.com/package/neutrino-preset-base)
* [html-webpack-plugin](https://www.npmjs.com/package/html-webpack-plugin) simplifies creation of HTML files to serve webpack bundles
* [webpack-dev-server](https://www.npmjs.com/package/webpack-dev-server) Serves a webpack app. Updates the browser on changes
* [Karma](https://www.npmjs.com/package/karma) Test Runner for JavaScript
[npm-image]: https://badge.fury.io/js/neutrino-preset-web.svg
[npm-url]: https://npmjs.org/package/neutrino-preset-web
[daviddm-image]: https://david-dm.org/mozilla-neutrino/neutrino-preset-web.svg
[daviddm-url]: https://david-dm.org/mozilla-neutrino/neutrino-preset-web

Loading…
Cancel
Save