Update README #371
Update README #371
Conversation
Delete a lot of the README in favour of linking to the site.
| ## News | ||
|
|
||
| **Upgrading from version 1 to 2:** the latest version of the kit (2.0.0 and later) is not compatible with previous versions. If you update your old prototypes you'll need to [convert them as well](https://govuk-prototype-kit.herokuapp.com/docs/updating-the-kit). | ||
| Go to the [GOV.UK Prototype Kit site](https://govuk-prototype-kit.herokuapp.com/docs) to download the latest version and read the documentation. | ||
|
|
||
| ## About the prototype kit |
There was a problem hiding this comment.
I'd delete the line about project principles.
There was a problem hiding this comment.
I think it's the only place it's linked to, so I'd like to keep it for now.
There was a problem hiding this comment.
I don't personally see the relevance to linking to them here. But I don't feel strongly about it.
README.md
Outdated
| @@ -16,26 +14,6 @@ If you publish your prototypes online, they **must** be protected by a [username | |||
|
|
|||
| You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like GOV.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately. | |||
|
|
|||
| ## Installation instructions | |||
There was a problem hiding this comment.
I feel like it's still valuable to link to the install instructions.
It's somewhat odd we don't have basic instructions for minimal install - eg npm install, npm start. I feel like most repos I come across contain a minimal set of instructions for running locally - without needing to go online to find out how.
| - [Updating the kit to the latest version](https://govuk-prototype-kit.herokuapp.com/docs/updating-the-kit) | ||
| - [Tips and tricks](https://govuk-prototype-kit.herokuapp.com/docs/tips-and-tricks) | ||
| - [Creating routes (server-side programming)](https://govuk-prototype-kit.herokuapp.com/docs/creating-routes) | ||
|
|
||
| ## Community | ||
|
|
||
| We have two Slack channels for the Prototype kit. You'll need a government email address to join them. |
There was a problem hiding this comment.
Should we link directly to the cross government slack here?
There was a problem hiding this comment.
whats the problem?
There was a problem hiding this comment.
It's not very helpful - it doesn't tell people where to find the channels. We can point them at the url to join slack.
There was a problem hiding this comment.
It links directly to the channels?
There was a problem hiding this comment.
Where? I don't see any links?
There was a problem hiding this comment.
Oops sorry, Github had collapsed the links. Nothing to see here.
Delete a lot of the README in favour of linking to the site.