Merge pull request #21 from commoncode/chore/update-readme

[chore] Update README

Author: stvmachine

README.md

@@ -1,2 +1,22 @@
 # commoners-mggj-2020
 Repo for "The Commoners" Global Game Jam Project 2020
+
+## Technologies
+This project was built using [React][react] / [TypeScript][typescript] in combination with `styled-components`, and a [NextJS][nextjs] server.
+
+
+## Getting Started
+:warning: You might have sound issues on Firefox.
+
+1. Install packages and run local dev environment (on `localhost:3000/`):
+```
+$ npm i
+$ npm run dev
+```
+
+It's basically a single page application making use of different react components to set the scenes of this game. 
+Have a look at `/components` to see what's available.
+
+[react]: https://reactjs.org/
+[typescript]: https://www.typescriptlang.org/
+[nextjs]: https://nextjs.org/

components/core/LoveMeter/LoveMeter.tsx

@@ -27,7 +27,7 @@ const LoveMeterSvg = () => (
             strokeWidth="4">
             <path d="M171.25 121.64c.58-2.69-3.11-7.22-5-3.78a126.41 126.41 0 01-29.32 28.2c-3.54-.13-2.53 6.33.82 4.32a42.64 42.64 0 008.63 1.29c-11.88 12.44-35.9 18.33-46.57 1.46.19-3.58-4.48-3.32-6.42-1.52a8.69 8.69 0 00-9.61 6.11 9.06 9.06 0 00-7.09.56c-2.38-1.34-7.3-9.63-8.23-3-10.43 14.84-33.31 2.35-43.28-7.62a9.63 9.63 0 019.16 0c2.2 1.34 4.22-2.12 2-3.45-6.23-4.15-11.4-9.92-17.14-14.77-4.5-4.11-9-8.63-11.37-14.37-.67-1.75-3.68-2.86-4.29-.39-3.78 17.07-.39 34.6 7 50.14a2 2 0 004 .29c.09-3 0-6.55 1.91-9.37C27.71 189.16 64 198.36 81.16 225.2a1.69 1.69 0 002.3.86 2 2 0 002.75-1.23c6.57-13.88 23.42-19.19 34.69-28.69 14-10 27.44-21.75 34.85-37.57 5.41 39.5 17.42-27.7 15.5-36.93zM102.83 5.85c-7-4.36-16.24-4.4-24.12-3.11a14.38 14.38 0 00-10.08 6.75 22.39 22.39 0 00-3.41 10.84A22.7 22.7 0 0068 32.67c2.16 3.86 5.53 6.79 9 9.44a246.12 246.12 0 011 30.23l-.54 10.93c-.09 1.16-.16 2.33-.26 3.49a1.71 1.71 0 00.36 1.24c.43 3.07.94 6.12 1.56 9.15.56 2.76 1.45 5.66 3.76 7.45a7.94 7.94 0 008.44.47c2.79-1.37 4.52-4.12 5.54-7a40 40 0 001.87-11.28 1.7 1.7 0 00-.06-.51c1.1-14.59 2.11-29.22 1.24-43.85l.31-.11a21.06 21.06 0 0012.29-17.23 21 21 0 00-9.68-19.24zM83.43 17.6a3.35 3.35 0 011.27-1.34 1.82 1.82 0 01.59-.28 1.89 1.89 0 001.08 0l.33-.08a2.26 2.26 0 00.86-.15A5.93 5.93 0 0190 16a6.11 6.11 0 012.92 1.82 2.23 2.23 0 01.44.57 7.37 7.37 0 01.48.87 2.16 2.16 0 01.1.25c.06.16.11.33.16.5s.07.27.1.4 0 .27.07.4V22.49a5.87 5.87 0 01-.22 1c-.06.21-.12.4-.19.6v.15l-.08.14A5.28 5.28 0 0191.22 27a5.63 5.63 0 01-1.57.58 6.07 6.07 0 01-2 .14 5.78 5.78 0 01-3.13-1.2 5.32 5.32 0 01-1.83-3.91 8.77 8.77 0 01.74-5.01zm10.11 77.62c-.54 2.1-1.42 4.46-3.25 5.77-1.51 1.08-3.56 1.52-5 .42s-2-3.62-2.37-5.53-.74-4-1.06-6c.22.43.43.86.64 1.29a3 3 0 001.26 1.25 3.35 3.35 0 002.41 2.64c1.69.46 4-.58 4.3-2.45s1.48-2.86 2.63-4.13l.18-.22a4 4 0 001.27-.51 1.9 1.9 0 00.06.54 39.67 39.67 0 01-1.07 6.93z" />
          </g>
-         <path d="M147.25 73.42c-7.08-9.8-19.63-15.2-31.63-14.16S93.16 67.05 86.31 76.6c-6.1-11.32-17-20.19-30.73-18C40.9 60.9 26.39 76.38 24.75 91c-1.89 17 9.64 32.11 19.39 44.81a240.45 240.45 0 0036.68 38.24 4.83 4.83 0 004.57 1 3.72 3.72 0 004.32-1.46c17.85-22.88 49.23-33.87 60.5-62.07 4.87-12.2 4.97-27.14-2.96-38.1z" fill="#f62f2a" stroke="#332424" stroke-miterlimit="10" stroke-width="4" data-name="Layer 2" />
+         <path d="M147.25 73.42c-7.08-9.8-19.63-15.2-31.63-14.16S93.16 67.05 86.31 76.6c-6.1-11.32-17-20.19-30.73-18C40.9 60.9 26.39 76.38 24.75 91c-1.89 17 9.64 32.11 19.39 44.81a240.45 240.45 0 0036.68 38.24 4.83 4.83 0 004.57 1 3.72 3.72 0 004.32-1.46c17.85-22.88 49.23-33.87 60.5-62.07 4.87-12.2 4.97-27.14-2.96-38.1z" fill="#f62f2a" stroke="#332424" strokeMiterlimit="10" strokeWidth="4" data-name="Layer 2" />
       </g>
    </Svg>
 

components/events/Leak/Leak.tsx

@@ -58,6 +58,7 @@ const Leak = (props: LeakProps) => {
               y={coordsActions.y + a.y}
               activation={props[a.action]}
               isToggled={showActions}
+              key={a.action}
             >
               {a.caption}
             </ActionCaption>