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.
stevesims · Aug 21, 2018 · 735bdb1 · 735bdb1
1 parent 105a675
commit 735bdb1
Show file tree

Hide file tree

Showing 21 changed files with 81 additions and 58 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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"