alphagov / govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.

https://frontend.design-system.service.gov.uk/

MIT License

1.19k stars 328 forks source link

Review `package/README` #753

Closed hannalaakso closed 6 years ago

hannalaakso commented 6 years ago

Since this is the doc that gets pushed to npm, we should review whether it should include installation instructions, usage instructions etc. that are included in the main repo docs.

kr8n3r commented 6 years ago

package has it's own README that gets published to npm, src one doesnt get copied over

kr8n3r commented 6 years ago

797

NickColley commented 6 years ago

At the moment the README published to npm is not great.

We could consider publishing the main README (without relative links)

We could consider publishing https://github.com/alphagov/govuk-frontend/blob/master/docs/installation/installing-with-npm.md

Or maybe something that mixes the two.

36degrees commented 6 years ago

Closed by #797