Merge pull request #516 from marinintim/update_readme

Update README on running locally

Author: martinheidegger

README.md

@@ -12,9 +12,7 @@ We ask that you make pull requests because changes to this repository will get d
 
 ## Running the app locally
 
-This is a static site, simply open `index.html` or use your favorite static file server to run local server.
-
-You can also use the included development static server by running the following commands:
+This is a static site with a build step, simply run `npm start`:
 
 ```
 npm install
@@ -40,19 +38,19 @@ This will prompt you to enter a language code and will generate your language fi
 
 When picking your language code, please use the correct code from the first column of this spreadsheet: http://en.wikiversity.org/wiki/ISO_639-1_language_matrix
 
-The way translations are implemented is using 100% client-side JavaScript. When the page is loaded the users browser locale is detected (using [browser-locale](http://npmjs.org/browser-locale)) and a XHR request is made to the `languages` folder to try and fetch a JSON translation file for that locale. First we check for the full 5 character locale file (e.g. `en-us`) and if that doesn't exist we fallback to the 2 character version (`en`) and if that doesn't exist we just do nothing and show the default English version.
+The way translations are implemented is building static pages using Codeship (see `./scripts` for details).
 
 Translation files are a mapping of translations IDs to the translated strings. There is a separate file called `languages/selectors.json` which maps CSS selectors in markup to the translation IDs.
 
 The good things about this approach:
 
+- Every language is indexed by search engines.
 - The site remains a static site. This means that contributing to the site is really easy as the entire site is just flat HTML, CSS, JS and JSON files
-- When PRs get merged they are immediately deployed live to GitHub pages. This makes maintenance really nice as there is no manual deploy step.
+- When PRs get merged they are almost immediately deployed live to GitHub pages. This makes maintenance really nice as there is no manual deploy step.
 
 The drawbacks of this approach:
 
-- Only the English (default) version is indexed by search engines
-- The English version briefly appears on page loads before the translated version is swapped in
+- Default branch is `source` as we can't use `master` anymore.
 
 ### Update Translations