Updating readme

.env

@@ -1 +1,14 @@
 PUBLIC_URL=/
+
+# site meta data
+REACT_APP_WEBSITE_NAME = "Ray Tracing in One Weekend"
+REACT_APP_WEBSITE_TITLE = "Ray Tracing in One Weekend"
+REACT_APP_WEBSITE_DESCRIPTION = "A simple Raytracer based on Ray Tracing in One Weekend by Peter Shirley"
+REACT_APP_WEBSITE_KEY_WORD = "Raytracing, WebGL, threejs"
+REACT_APP_WEBSITE_SITE_URL = "https://ameliemaia.github.io/raytracing-in-one-weekend/"
+REACT_APP_WEBSITE_OG_LOCALE = "en_US"
+REACT_APP_WEBSITE_OG_IMAGE = "assets/images/raytracing-in-one-weekend.jpg"
+REACT_APP_WEBSITE_TW_CARD = "summary"
+
+
+

.env.gh-pages

@@ -1 +1 @@
-PUBLIC_URL=/raytracing
+PUBLIC_URL=/raytracing-in-one-weekend

README.md

@@ -1 +1,11 @@
-# Raytracing in one weekend
+# Raytracing in One Weekend
+
+![](public/assets/images/raytracing-in-one-weekend.jpg)
+
+A simple [Raytracer](https://ameliemaia.github.io/raytracing-in-one-weekend/) based on [Ray Tracing in One Weekend](https://raytracing.github.io/) by [Peter Shirley](https://twitter.com/Peter_shirley).
+
+This is still a work in progress as I haven't completed the book yet :)
+
+This WebApp is based on [WebGL React App](https://github.com/jam3/webgl-react-app) by [Jam3](https://www.jam3.com/).
+
+License MIT

package.json

@@ -5,8 +5,8 @@
   "keywords": [
     "webgl",
     "threejs",
-    "raytracing",
-\  ],
+    "raytracing"
+  ],
   "private": true,
   "author": {
     "name": "Amelie Maia Rosser",
@@ -31,7 +31,7 @@
     "js-lint": "eslint './src/**/*.js' -c ./.eslintrc.json --quiet --ignore-pattern .gitignore",
     "flow": "flow",
     "flow-typed": "flow-typed install",
-    "linters": "npm-run-all flow js-lint",
+    "linters": "#npm-run-all flow js-lint",
     "assets": "node scripts/assets/optimise",
     "postinstall": "npm run flow-typed"
   },

public/index.html

@@ -7,6 +7,18 @@
     <meta name="theme-color" content="#000000" />
     <meta name="description" content="Jam3's WebGL React App Boilerplate" />
     <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo180.png" />
+
+    <meta property="og:locale" content="%REACT_APP_WEBSITE_OG_LOCALE%" />
+    <meta property="og:title" content="%REACT_APP_WEBSITE_TITLE%" />
+    <meta property="og:description" content="%REACT_APP_WEBSITE_DESCRIPTION%" />
+    <meta property="og:type" content="website" />
+    <meta property="og:url" content="%REACT_APP_WEBSITE_SITE_URL%" />
+    <meta property="og:site_name" content="%REACT_APP_WEBSITE_NAME%" />
+    <meta property="og:image:width" content="1200" />
+    <meta property="og:image:height" content="630" />
+    <meta property="og:image" content="%REACT_APP_WEBSITE_SITE_URL%%REACT_APP_WEBSITE_OG_IMAGE%" />
+    <meta name="twitter:card" content="%REACT_APP_WEBSITE_TW_CARD%" />
+
     <!--
       manifest.json provides metadata used when your web app is installed on a
       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/