From d55fce5bff69f06dceb066f04b3d24d96378885f Mon Sep 17 00:00:00 2001 From: Cyril Wanner Date: Thu, 15 Mar 2018 16:51:46 +0100 Subject: [PATCH] Rename package to next-compose-plugins --- README.md | 12 ++++++------ package.json | 8 ++++---- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e36cd94..4c29f11 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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); ``` @@ -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'); @@ -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 diff --git a/package.json b/package.json index 77cad30..5659372 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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", @@ -19,7 +19,7 @@ "author": "Cyril Wanner ", "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" }