diff --git a/README.md b/README.md index 3afd281..267bffb 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,27 @@

### Create and build modern JavaScript applications with zero initial configuration -#### Think Webpack, but with presets. That's Neutrino. +#### Neutrino combines the power of Webpack with the simplicity of presets. ---- - -Neutrino is a companion tool which lets you build web and Node.js applications with shared presets or configurations. It intends to make the process of initializing and building projects much simpler by providing minimal development dependencies. +[![NPM version][npm-image]][npm-url] [![NPM version][npm-downloads]][npm-url] -Neutrino uses Webpack to build both web and Node.js projects by providing complete build presets which can be shared across targets and projects. You can use Neutrino base presets to get started building a variety of projects, create your -own presets by extending the Neutrino core ones to be shared across your own projects or even by the community. Presets can even be manipulated on a project-by-project basis to handle almost any build situation your preset doesn't cover. - -[Get started with the docs!](https://neutrino.js.org) +--- -[![npm](https://img.shields.io/npm/l/neutrino.svg)]() +Neutrino is a companion tool which lets you build web and Node.js applications with shared presets or configurations. +It intends to make the process of initializing and building projects much simpler by providing minimal development +dependencies. -[![GitHub issues](https://img.shields.io/github/issues/mozilla-neutrino/neutrino-dev.svg)]() +Neutrino uses Webpack to build both web and Node.js projects by providing complete build presets which can be shared +across targets and projects. You can use Neutrino base presets to get started building a variety of projects, create +your own presets by extending the Neutrino core ones to be shared across your own projects or even by the community. +Presets can even be manipulated on a project-by-project basis to handle almost any build situation your preset doesn't +cover. -[![GitHub pull requests](https://img.shields.io/github/issues-pr/mozilla-neutrino/neutrino-dev.svg)]() +## Documentation -[![GitHub contributors](https://img.shields.io/github/contributors/mozilla-neutrino/neutrino-dev.svg)]() +See the [Neutrino docs](https://neutrino.js.org/) +for details on installation, getting started, usage, and customizing. +[npm-image]: https://img.shields.io/npm/v/neutrino.svg +[npm-downloads]: https://img.shields.io/npm/dt/neutrino.svg +[npm-url]: https://npmjs.org/package/neutrino diff --git a/docs/README.md b/docs/README.md index 562490b..267bffb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,15 @@

### Create and build modern JavaScript applications with zero initial configuration -#### Think Webpack, but with presets. That's Neutrino. +#### Neutrino combines the power of Webpack with the simplicity of presets. -[![NPM version][npm-image]][npm-url] +[![NPM version][npm-image]][npm-url] [![NPM version][npm-downloads]][npm-url] --- Neutrino is a companion tool which lets you build web and Node.js applications with shared presets or configurations. It intends to make the process of initializing and building projects much simpler by providing minimal development -dependencies. +dependencies. Neutrino uses Webpack to build both web and Node.js projects by providing complete build presets which can be shared across targets and projects. You can use Neutrino base presets to get started building a variety of projects, create @@ -17,5 +17,11 @@ your own presets by extending the Neutrino core ones to be shared across your ow Presets can even be manipulated on a project-by-project basis to handle almost any build situation your preset doesn't cover. +## Documentation + +See the [Neutrino docs](https://neutrino.js.org/) +for details on installation, getting started, usage, and customizing. + [npm-image]: https://img.shields.io/npm/v/neutrino.svg +[npm-downloads]: https://img.shields.io/npm/dt/neutrino.svg [npm-url]: https://npmjs.org/package/neutrino diff --git a/packages/neutrino/README.md b/packages/neutrino/README.md index f9baeb6..267bffb 100644 --- a/packages/neutrino/README.md +++ b/packages/neutrino/README.md @@ -1,7 +1,7 @@

### Create and build modern JavaScript applications with zero initial configuration -#### Think Webpack, but with presets. That's Neutrino. +#### Neutrino combines the power of Webpack with the simplicity of presets. [![NPM version][npm-image]][npm-url] [![NPM version][npm-downloads]][npm-url] @@ -9,7 +9,7 @@ Neutrino is a companion tool which lets you build web and Node.js applications with shared presets or configurations. It intends to make the process of initializing and building projects much simpler by providing minimal development -dependencies. +dependencies. Neutrino uses Webpack to build both web and Node.js projects by providing complete build presets which can be shared across targets and projects. You can use Neutrino base presets to get started building a variety of projects, create