Update readme in npm package #804

kr8n3r · 2018-06-18T10:36:25Z

Currently the contents is out of date.
Proposed change includes parts of the main readme and parts of https://github.com/alphagov/govuk-frontend/blob/master/docs/installation/installing-with-npm.md with introduction bits and links to more details

Todo:

add correct DS URL
review JS initialisation

Adresses: #753

NickColley · 2018-06-18T11:12:03Z

package/README.md


-### Build tool configuration
+You can include Javascript for all components either by copying the `all.js` from `node_modules/govuk-frontend` into your application or referencing the file directly:


These changes are good but it makes me uneasy that they've not been made consistently in the installation section...

TechPunk316 · 2018-06-19T13:59:34Z

Hi all,

Reads well, I have a few comments/suggestions below:

Worth adding a link to NPM under the 'Requirements' subhead
Make the 3 'more details' links more descriptive:
Suggest changing them to "More details on importing styles", "More details on importing Javascript and advanced options", "More details on importing assets"
Change "initialising it in your application to ensure that all users can properly use it"
to "initialising Javascript in your application to ensure that all users can use it successfully"
Change "import assets" subhead to "importing assets" for consistency

hannalaakso · 2018-06-19T16:00:32Z

Thanks @TechPunk316 for the review! 👍

I've made the required changes and also reflected these in the installation docs.

Additionally, I've updated package README to include links to the two installation docs, this reflects the repo README.

I'll squash the commits once approved.

36degrees · 2018-06-20T11:31:59Z

package/README.md


-    npm install --save govuk-frontend
+Install the long-term support (LTS) version of [Node.js](https://nodejs.org/en/), which includes NPM. The minimum version of Node required is 8.6.0.


Is this true?

No, this is the minimum we require to contribute GOV.UK Frontend, not to consume it.

I've removed this section as it duplicates the npm installation instructions and is not true if you decide to install with option 2.

In the npm installation instructions, I've downgraded the version of node required to 4.2.0. which builds with nunjucks 3.0.0 and the nunjucks templates render.

Our contributing docs still say that Node 8.6.0 is required.

36degrees · 2018-06-20T11:33:30Z

package/README.md

+### 1. Install with npm (recommended)
+
+We recommend [installing GOV.UK Frontend using node package manager
+(npm)](docs/installation/installing-with-npm.md).


This link is broken – and when this is published to npm we can't reference another path relatively at all. Suggest making this a link including github.com (like we have for 'More details on importing styles')?

There's a few other links in this file that are also broken – I won't comment on them all.

36degrees · 2018-06-20T11:33:58Z

package/README.md

+
+To import add the below to your Sass file:
+
+  ```CSS


I think this should be scss for correct highlighting.

36degrees

Few very minor comments, but this is looking ace 👌

36degrees · 2018-06-20T15:01:17Z

package/README.md

-    npm install --save govuk-frontend
+Once installed, you will be able to use the code from the examples in the
+[GOV.UK Design System](https://www.gov.uk/design-system)
+in your service.


Minor: I don't think this needs to be wrapped onto a new line now that the URL is shorter.

36degrees · 2018-06-20T15:01:42Z

package/README.md

+
+You can include Javascript for all components either by copying the `all.js` from `node_modules/govuk-frontend` into your application or referencing the file directly:
+
+```js


This is HTML.

36degrees · 2018-06-20T15:01:48Z

package/README.md

+```
+Next you need to initialise the script by adding:
+
+```js


As is this.

alex-ju · 2018-06-20T15:13:39Z

package/README.md

-      autoescape: true,
-      cache: false,
-      express: app
-    })

 ## Getting updates


Can we update this text too?
To check whether you have the latest version of the button run:

Also To update the latest version run: may be clear as To update to the latest version run:

36degrees

🎉

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 18, 2018 10:36 Inactive

kr8n3r force-pushed the update-package-readme branch from b20c1cd to 2593426 Compare June 18, 2018 10:39

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 18, 2018 10:40 Inactive

kr8n3r force-pushed the update-package-readme branch from 2593426 to 8a03278 Compare June 18, 2018 10:54

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 18, 2018 10:54 Inactive

NickColley reviewed Jun 18, 2018

View reviewed changes

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 19, 2018 15:42 Inactive

hannalaakso force-pushed the update-package-readme branch from 3854abe to 2f5f0e4 Compare June 19, 2018 15:51

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 19, 2018 15:51 Inactive

36degrees changed the title ~~RFC: Update readme in npm package~~ Update readme in npm package Jun 20, 2018

36degrees added this to the v1.0.0 milestone Jun 20, 2018

36degrees reviewed Jun 20, 2018

View reviewed changes

hannalaakso force-pushed the update-package-readme branch from 2f5f0e4 to 549750c Compare June 20, 2018 14:47

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 20, 2018 14:47 Inactive

hannalaakso force-pushed the update-package-readme branch from 549750c to beb5d46 Compare June 20, 2018 14:50

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 20, 2018 14:50 Inactive

hannalaakso force-pushed the update-package-readme branch from beb5d46 to db86209 Compare June 20, 2018 14:52

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 20, 2018 14:52 Inactive

hannalaakso force-pushed the update-package-readme branch from db86209 to 4ceb3ec Compare June 20, 2018 15:00

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 20, 2018 15:00 Inactive

36degrees reviewed Jun 20, 2018

View reviewed changes

hannalaakso force-pushed the update-package-readme branch from 4ceb3ec to 64a828f Compare June 20, 2018 15:11

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 20, 2018 15:11 Inactive

hannalaakso force-pushed the update-package-readme branch from 64a828f to f8185ab Compare June 20, 2018 15:13

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 20, 2018 15:13 Inactive

alex-ju reviewed Jun 20, 2018

View reviewed changes

hannalaakso force-pushed the update-package-readme branch from f8185ab to c821490 Compare June 20, 2018 15:19

govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-804 June 20, 2018 15:20 Inactive

Jani Kraner and others added 2 commits June 20, 2018 16:22

Update readme in npm package to be more accurate

f6004a0

update changelog

c88039e

hannalaakso force-pushed the update-package-readme branch from c821490 to c88039e Compare June 20, 2018 15:22

36degrees approved these changes Jun 20, 2018

View reviewed changes

govuk-design-system-ci deployed to govuk-frontend-review-pr-804 June 20, 2018 15:22 View deployment

hannalaakso merged commit 6bce9a1 into master Jun 20, 2018

hannalaakso deleted the update-package-readme branch June 20, 2018 16:08

This was referenced Jun 21, 2018

Release v1.0 #809

Closed

Release v1.0.0 #810

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme in npm package #804

Update readme in npm package #804

kr8n3r commented Jun 18, 2018 •

edited

NickColley Jun 18, 2018

TechPunk316 commented Jun 19, 2018

hannalaakso commented Jun 19, 2018 •

edited

36degrees Jun 20, 2018

NickColley Jun 20, 2018

hannalaakso Jun 20, 2018

36degrees Jun 20, 2018

36degrees Jun 20, 2018

36degrees left a comment

36degrees Jun 20, 2018

36degrees Jun 20, 2018

36degrees Jun 20, 2018

alex-ju Jun 20, 2018

alex-ju Jun 20, 2018

36degrees Jun 20, 2018

36degrees left a comment


		### Build tool configuration
		You can include Javascript for all components either by copying the `all.js` from `node_modules/govuk-frontend` into your application or referencing the file directly:


		npm install --save govuk-frontend
		Install the long-term support (LTS) version of [Node.js](https://nodejs.org/en/), which includes NPM. The minimum version of Node required is 8.6.0.


		You can include Javascript for all components either by copying the `all.js` from `node_modules/govuk-frontend` into your application or referencing the file directly:

		```js

Update readme in npm package #804

Update readme in npm package #804

Conversation

kr8n3r commented Jun 18, 2018 • edited

Choose a reason for hiding this comment

TechPunk316 commented Jun 19, 2018

hannalaakso commented Jun 19, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

36degrees left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

36degrees left a comment

Choose a reason for hiding this comment

kr8n3r commented Jun 18, 2018 •

edited

hannalaakso commented Jun 19, 2018 •

edited