Skip to content

Commit

Permalink
Rename package to next-compose-plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
Cyril Wanner committed Mar 15, 2018
1 parent 883b4fa commit d55fce5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# 💡 next-plugins [![npm version](https://img.shields.io/npm/v/next-plugins.svg)](https://www.npmjs.com/package/next-plugins) [![license](https://img.shields.io/github/license/cyrilwanner/next-plugins.svg)](https://github.com/cyrilwanner/next-plugins/blob/master/LICENSE)
# 💡 next-compose-plugins [![npm version](https://img.shields.io/npm/v/next-compose-plugins.svg)](https://www.npmjs.com/package/next-compose-plugins) [![license](https://img.shields.io/github/license/cyrilwanner/next-compose-plugins.svg)](https://github.com/cyrilwanner/next-compose-plugins/blob/master/LICENSE)

Provides a cleaner API for enabling and configuring plugins for [next.js](https://github.com/zeit/next.js) because the default way next.js suggests to enable and configure plugins can get unclear and confusing when you have many plugins.

It is often unclear which plugins are enabled or which configuration belongs to which plugin because they are nested and share one configuration object.
This can also lead to orphaned configuration values when updating or removing plugins.

`next-plugins` tries to eliminate this case by providing an alternative API for enabling and configuring plugins where each plugin has their own configuration object.
`next-compose-plugins` tries to eliminate this case by providing an alternative API for enabling and configuring plugins where each plugin has their own configuration object.

## Table of contents

Expand All @@ -18,13 +18,13 @@ This can also lead to orphaned configuration values when updating or removing pl
## Installation

```
npm install --save next-plugins
npm install --save next-compose-plugins
```

## Usage
```javascript
// next.config.js
const withPlugins = require('next-plugins');
const withPlugins = require('next-compose-plugins');

module.exports = withPlugins([...plugins], nextConfiguration);
```
Expand All @@ -43,7 +43,7 @@ Any direct [next.js configuration](https://github.com/zeit/next.js#custom-config

```javascript
// next.config.js
const withPlugins = require('next-plugins');
const withPlugins = require('next-compose-plugins');
const images = require('next-images');
const sass = require('@zeit/next-sass');
const typescript = require('@zeit/next-typescript');
Expand Down Expand Up @@ -111,4 +111,4 @@ See [zeit/next-plugins](https://github.com/zeit/next-plugins) for a list of offi

## License

[MIT](https://github.com/cyrilwanner/next-plugins/blob/master/LICENSE) © Cyril Wanner
[MIT](https://github.com/cyrilwanner/next-compose-plugins/blob/master/LICENSE) © Cyril Wanner
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "next-plugins",
"name": "next-compose-plugins",
"version": "1.0.1",
"description": "Provides a cleaner API for enabling and configuring plugins for next.js",
"main": "index.js",
Expand All @@ -8,7 +8,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/cyrilwanner/next-plugins.git"
"url": "git+https://github.com/cyrilwanner/next-compose-plugins.git"
},
"keywords": [
"next.js",
Expand All @@ -19,7 +19,7 @@
"author": "Cyril Wanner <info@cyr.li>",
"license": "MIT",
"bugs": {
"url": "https://github.com/cyrilwanner/next-plugins/issues"
"url": "https://github.com/cyrilwanner/next-compose-plugins/issues"
},
"homepage": "https://github.com/cyrilwanner/next-plugins#readme"
"homepage": "https://github.com/cyrilwanner/next-compose-plugins#readme"
}

0 comments on commit d55fce5

Please sign in to comment.