Merge pull request #193 from nhsalpha/update-readme

Rework README
nhsuk-archive · Jun 3, 2016 · b692896 · b692896
2 parents c3d2172 + 86acab1
commit b692896
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 202 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-# NHS.UK Alpha Prototyping Kit
+# NHS.UK Alpha Prototypes
 
-This kit is adapted from the [GOV.UK prototyping kit.](https://github.com/alphagov/govuk_prototype_kit).
+Prototypes from the NHS Alpha project, from July 2015 to January 2016.
 
-The kit provides a simple way to make interactive prototypes for NHS.UK alpha. These prototypes can be used to show ideas to people you work with, and to do user research.
+These prototypes have been built on an adapted [GOV.UK prototyping kit.](https://github.com/alphagov/govuk_prototype_kit).
 
-It's built on the [Express](http://expressjs.com/) framework and contains code adapted from these GOV.UK resources:
+They contain code from these GOV.UK resources:
 
 - [GOV.UK template](https://github.com/alphagov/govuk_template)
 - [GOV.UK front end toolkit](https://github.com/alphagov/govuk_frontend_toolkit)
@@ -41,7 +41,8 @@ git clone https://github.com/nhsalpha/nhs_prototype_kit.git
 npm install
 ```
 
-This will install folders containing programs described by the package.json file to a folder called `node_modules`.
+This will install folders containing programs described by the package.json
+file to a folder called `node_modules`.
 
 #### Run the app
 
@@ -50,22 +51,3 @@ node start.js
 ```
 
 Go to [localhost:3000](http://localhost:3000) in your browser.
-
-#### Hot reload
-
-Any code changes should update in the browser without you restarting the app.
-
-The app recompiles app/assets/stylesheets/application.scss everytime changes are observed.
-
-## Documentation
-
-Find out how to work with the prototyping application.
-
-* [Getting started](docs/getting-started.md) (Read this first)
-* [Creating routes](docs/creating-routes.md)
-* [Making pages](docs/making-pages.md)
-* [Writing CSS](docs/writing-css.md)
-* [Deploying (getting your work online)](docs/deploying.md)
-
-This project is built on top of Express, the idea is that it is straightforward to create simple static pages out of the box. However, you're not limited to that - more dynamic sites can be built with more understanding of Express. Here's a good [Express tutorial.](http://code.tutsplus.com/tutorials/introduction-to-express--net-33367)
-
diff --git a/docs/creating-routes.md b/docs/creating-routes.md
diff --git a/docs/deploying.md b/docs/deploying.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/making-pages.md b/docs/making-pages.md
diff --git a/docs/writing-css.md b/docs/writing-css.md