Updated Readme file.

Author: sboots

README.md

@@ -1,16 +1,12 @@
-# Victor Hugo
+# goc-spending-website-v1
 
-**A Hugo boilerplate for creating truly epic websites**
+This repository powers the <https://goc-spending.github.io/> website.
 
-This is a boilerplate for using [Hugo](https://gohugo.io/) as a static site generator and [Webpack](https://webpack.js.org/) as your asset pipeline.
-
-Victor Hugo setup to use [PostCSS](http://postcss.org/) and [Babel](https://babeljs.io/) for CSS and JavaScript compiling/transpiling.
-
-This project is released under the [MIT license](LICENSE). Please make sure you understand its implications and guarantees.
+It's based on Netlify's [Victor Hugo](https://github.com/netlify-templates/victor-hugo) package, a boilerplate for using [Hugo](https://gohugo.io/) as a static site generator and [Webpack](https://webpack.js.org/) as an asset pipeline.
 
 ## Usage
 
-### :exclamation: Prerequisites
+### Prerequisites
 
 You need to have the latest/LTS [node](https://nodejs.org/en/download/) and [npm](https://www.npmjs.com/get-npm) versions installed in order to use Victor Hugo.
 
@@ -22,7 +18,7 @@ npm install
 
 This will take some time and will install all packages necessary to run Victor Hugo and its tasks.
 
-### :construction_worker: Development
+### Development
 
 While developing your website, use:
 
@@ -38,7 +34,7 @@ npm run preview
 
 Then visit http://localhost:3000/ _- or a new browser windows popped-up already -_ to preview your new website. Webpack Dev Server will automatically reload the CSS or refresh the whole page, when stylesheets or content changes.
 
-### :package: Static build
+### Static build
 
 To build a static version of the website inside the `/dist` folder, run:
 
@@ -54,63 +50,20 @@ npm run build:preview
 
 See [package.json](package.json#L8) for all tasks.
 
-## Structure
-
-```
-|--site                // Everything in here will be built with hugo
-|  |--content          // Pages and collections - ask if you need extra pages
-|  |--data             // YAML data files with any data for use in examples
-|  |--layouts          // This is where all templates go
-|  |  |--partials      // This is where includes live
-|  |  |--index.html    // The index page
-|  |--static           // Files in here ends up in the public folder
-|--src                 // Files that will pass through the asset pipeline
-|  |--css              // Webpack will bundle imported css seperately
-|  |--index.js         // index.js is the webpack entry for your css & js assets
-```
-
-## Basic Concepts
-
-You can read more about Hugo's template language in their documentation here:
-
-https://gohugo.io/templates/overview/
-
-The most useful page there is the one about the available functions:
-
-https://gohugo.io/templates/functions/
-
-For assets that are completely static and don't need to go through the asset pipeline,
-use the `site/static` folder. Images, font-files, etc, all go there.
+### Deploying
 
-Files in the static folder end up in the web root. So a file called `site/static/favicon.ico`
-will end up being available as `/favicon.ico` and so on...
+This version has been customized to deploy to a separate repo, using GitHub Pages.
 
-The `src/index.js` file is the entrypoint for webpack and will be built to `/dist/main.js`
+To deploy an updated version of the website, run:
 
-You can use **ES6** and use both relative imports or import libraries from npm.
-
-Any CSS file imported into the `index.js` will be run through Webpack, compiled with [PostCSS Next](http://cssnext.io/), and
-minified to `/dist/[name].[hash:5].css`. Import statements will be resolved as part of the build.
-
-## Environment variables
-
-To separate the development and production _- aka build -_ stages, all gulp tasks run with a node environment variable named either `development` or `production`.
-
-You can access the environment variable inside the theme files with `getenv "NODE_ENV"`. See the following example for a conditional statement:
-
-    {{ if eq (getenv "NODE_ENV") "development" }}You're in development!{{ end }}
-
-All tasks starting with _build_ set the environment variable to `production` - the other will set it to `development`.
-
-## Deploying to Netlify
-
-- Push your clone to your own GitHub repository.
-- [Create a new site on Netlify](https://app.netlify.com/start) and link the repository.
+```bash
+npm run deploy
+```
 
-Now Netlify will build and deploy your site whenever you push to git.
+## About
 
-You can also click this button:
+This repository is part of a larger collection of tools to analyze and visualize Government of Canada contract spending.
 
-[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/victor-hugo)
+For more information, see the [main goc-spending repository](https://github.com/GoC-Spending/goc-spending).
 
-## Enjoy!! 😸
+This is a volunteer project and is not affiliated with the Government of Canada.