From 735bdb180b6f854610934ca934d4186a9697e2f3 Mon Sep 17 00:00:00 2001 From: Gavin Orland Date: Tue, 14 Aug 2018 16:20:00 +0100 Subject: [PATCH] Update package authors, homepages and descriptions Here's a start, at least, on updating these various packages, addressing #54. I've provided basic descriptions of each component - open to change. Also tried to credit authors correctly, but may have this wrong - in particularly may have understated @Loque-'s contributions because I'm not aware of what he did. Open to ideas on this. --- components/array-object-table/package.json | 7 ++++--- components/arrow-left/package.json | 7 ++++--- components/arrow/package.json | 7 ++++--- components/compact-table-accordion-group/package.json | 7 ++++--- components/count/package.json | 7 ++++--- components/countdown-text-area/package.json | 7 ++++--- components/counter-bar/package.json | 6 +++--- components/distraction-free/package.json | 7 ++++--- components/header-button/package.json | 7 ++++--- components/keyline/package.json | 7 ++++--- components/object-table/package.json | 7 ++++--- components/open-button/package.json | 7 ++++--- components/remove-button/package.json | 7 ++++--- components/result-count-title/package.json | 7 ++++--- components/result-count/package.json | 7 ++++--- components/spinner/package.json | 7 ++++--- components/table-accordion-group/package.json | 7 ++++--- components/table-of-contents/package.json | 7 +++++-- components/table/package.json | 5 +++-- components/title-result-count/package.json | 8 +++++--- package.json | 1 + 21 files changed, 81 insertions(+), 58 deletions(-) diff --git a/components/array-object-table/package.json b/components/array-object-table/package.json index ea477c7..b9238cb 100644 --- a/components/array-object-table/package.json +++ b/components/array-object-table/package.json @@ -23,10 +23,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Gavin Orland", + "author": "Steve Sims", + "contributors": ["Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/array-object-table", + "description": "Renders a table from an an array of objects, providing they have properties which match provided the keys. Also supports transforms of undefined values.", "private": false, "publishConfig": { "access": "public" diff --git a/components/arrow-left/package.json b/components/arrow-left/package.json index 4b3bdef..4b4fec0 100644 --- a/components/arrow-left/package.json +++ b/components/arrow-left/package.json @@ -23,10 +23,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/arrow-left", + "description": "Left-pointing arrow icon inside circle, with customisable color, width and fill.", "private": false, "publishConfig": { "access": "public" diff --git a/components/arrow/package.json b/components/arrow/package.json index 8a6cf7a..49e9bea 100644 --- a/components/arrow/package.json +++ b/components/arrow/package.json @@ -17,10 +17,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/arrow", + "description": "Downward-pointing triangular icon created using SVG.", "private": false, "publishConfig": { "access": "public" diff --git a/components/compact-table-accordion-group/package.json b/components/compact-table-accordion-group/package.json index e098a05..4748314 100644 --- a/components/compact-table-accordion-group/package.json +++ b/components/compact-table-accordion-group/package.json @@ -24,10 +24,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/compact-table-accordion-group", + "description": "An accordion menu with various customisable features.", "private": false, "publishConfig": { "access": "public" diff --git a/components/count/package.json b/components/count/package.json index 88e5aea..47ca777 100644 --- a/components/count/package.json +++ b/components/count/package.json @@ -22,10 +22,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/count", + "description": "Renders a number sent in as a prop.", "private": false, "publishConfig": { "access": "public" diff --git a/components/countdown-text-area/package.json b/components/countdown-text-area/package.json index 20d9342..38377a6 100644 --- a/components/countdown-text-area/package.json +++ b/components/countdown-text-area/package.json @@ -24,10 +24,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/countdown-text-area", + "description": "TextArea which accepts a maxlength prop and renders a TextAreaField, limits characters and styles accordingly.", "private": false, "publishConfig": { "access": "public" diff --git a/components/counter-bar/package.json b/components/counter-bar/package.json index 9ee9471..2b06337 100644 --- a/components/counter-bar/package.json +++ b/components/counter-bar/package.json @@ -25,10 +25,10 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Gavin Orland", "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/counter-bar", + "description": "A 'construction kit' for creating a counter bar with counters and a total, with various configurable parameters.", "private": false, "publishConfig": { "access": "public" diff --git a/components/distraction-free/package.json b/components/distraction-free/package.json index 4cb2d4a..bf846cb 100644 --- a/components/distraction-free/package.json +++ b/components/distraction-free/package.json @@ -24,10 +24,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/distraction-free", + "description": "Provides border, arrow-left button and body area for document display.", "private": false, "publishConfig": { "access": "public" diff --git a/components/header-button/package.json b/components/header-button/package.json index 8df8a45..828297b 100644 --- a/components/header-button/package.json +++ b/components/header-button/package.json @@ -23,10 +23,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/header-button", + "description": "Styled button with further optional active and disabled styles.", "private": false, "publishConfig": { "access": "public" diff --git a/components/keyline/package.json b/components/keyline/package.json index de6349b..b89eb85 100644 --- a/components/keyline/package.json +++ b/components/keyline/package.json @@ -25,10 +25,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/keyline", + "description": "Renders a bottom border with optional inline-block and colour.", "private": false, "publishConfig": { "access": "public" diff --git a/components/object-table/package.json b/components/object-table/package.json index 79dbfea..0adfd68 100644 --- a/components/object-table/package.json +++ b/components/object-table/package.json @@ -23,10 +23,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Gavin Orland", + "author": "Toby Brancher", + "contributors": ["Steve Sims", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/object-table", + "description": "Renders a table from an object whose properties match provided fields. Also supports transforms for values.", "private": false, "publishConfig": { "access": "public" diff --git a/components/open-button/package.json b/components/open-button/package.json index 625f129..9895449 100644 --- a/components/open-button/package.json +++ b/components/open-button/package.json @@ -22,10 +22,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/open-button", + "description": "Uses Arrow icon and manage-state to create a button which toggles rotation when clicked and can accept an event handler.", "private": false, "publishConfig": { "access": "public" diff --git a/components/remove-button/package.json b/components/remove-button/package.json index ccaf65e..f58ef13 100644 --- a/components/remove-button/package.json +++ b/components/remove-button/package.json @@ -22,10 +22,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/remove-button", + "description": "Renders a styled button containing an x character.", "private": false, "publishConfig": { "access": "public" diff --git a/components/result-count-title/package.json b/components/result-count-title/package.json index c58390c..908cb5c 100644 --- a/components/result-count-title/package.json +++ b/components/result-count-title/package.json @@ -23,10 +23,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/result-count-title", + "description": "Renders a ResultCount with value sent as a prop, along with a title sent as children.", "private": false, "publishConfig": { "access": "public" diff --git a/components/result-count/package.json b/components/result-count/package.json index 08b2fa6..9a1a490 100644 --- a/components/result-count/package.json +++ b/components/result-count/package.json @@ -23,10 +23,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/result-count", + "description": "Renders children, expected to be a number, styled and with customisable color and background-color.", "private": false, "publishConfig": { "access": "public" diff --git a/components/spinner/package.json b/components/spinner/package.json index b6520aa..980f9f8 100644 --- a/components/spinner/package.json +++ b/components/spinner/package.json @@ -19,10 +19,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/spinner", + "description": "Renders an animated GIF as Base-64 - prop sets visibility.", "private": false, "publishConfig": { "access": "public" diff --git a/components/table-accordion-group/package.json b/components/table-accordion-group/package.json index a462971..28f1244 100644 --- a/components/table-accordion-group/package.json +++ b/components/table-accordion-group/package.json @@ -26,10 +26,11 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/table-accordion-group", + "description": "Accordion menu which uses manage-state and react-collapse.", "private": false, "publishConfig": { "access": "public" diff --git a/components/table-of-contents/package.json b/components/table-of-contents/package.json index 3e136bd..2dc62c1 100644 --- a/components/table-of-contents/package.json +++ b/components/table-of-contents/package.json @@ -2,7 +2,6 @@ "name": "@govuk-frederic/table-of-contents", "version": "0.1.0", "private": false, - "license": "MIT", "publishConfig": { "access": "public" }, @@ -23,5 +22,9 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Steve Sims" + "author": "Toby Brancher", + "contributors": ["Steve Sims", "Gavin Orland"], + "license": "MIT", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/table-of-contents", + "description": "Construction kit to build a table of contents - uses Context API." } diff --git a/components/table/package.json b/components/table/package.json index 5e76d90..836f0b8 100644 --- a/components/table/package.json +++ b/components/table/package.json @@ -24,9 +24,10 @@ "main": "lib/index.js", "module": "es/index.js", "author": "Tarandeep Singh Chauhan", + "contributors": ["Steve Sims", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/table", + "description": "Renders a table with optional heading row. Cell data is derived from an array and can include names per cell or per row.", "private": false, "publishConfig": { "access": "public" diff --git a/components/title-result-count/package.json b/components/title-result-count/package.json index 3c3fdae..ac84006 100644 --- a/components/title-result-count/package.json +++ b/components/title-result-count/package.json @@ -23,10 +23,12 @@ }, "main": "lib/index.js", "module": "es/index.js", - "author": "Tarandeep Singh Chauhan", + "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland"], "license": "MIT", - "homepage": "https://github.com/stevesims/govuk-frederic#readme", - "description": "govuk-frederic: Frederic project specific components.", + "homepage": "https://www.npmjs.com/package/@govuk-frederic/title-result-count", + "description": "Renders a ResultCount using count prop provided and a title from children.", + "private": false, "private": false, "publishConfig": { "access": "public" diff --git a/package.json b/package.json index b20ddad..4c6aed6 100644 --- a/package.json +++ b/package.json @@ -146,6 +146,7 @@ "url": "https://github.com/stevesims/govuk-frederic.git" }, "author": "Steve Sims", + "contributors": ["Tarandeep Singh Chauhan", "Gavin Orland", "Toby Brancher"], "license": "MIT", "bugs": { "url": "https://github.com/stevesims/govuk-frederic/issues"