✨ Improvements

.eslintrc.json

@@ -0,0 +1,41 @@
+{
+    "env": {
+        "browser": true,
+        "es6": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended"
+    ],
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 2018,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "indent": [
+            "error",
+            4
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "never"
+        ]
+    }
+}

.github/workflows/nodejs.yml

@@ -4,23 +4,22 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [8.x, 10.x, 12.x]
+        node-version: [10.x, 12.x]
 
     steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: npm install, build, and test
-      run: |
-        npm install
-        npm run build --if-present
-        npm test
-      env:
-        CI: true
+      - uses: actions/checkout@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: npm install, build, and test
+        run: |
+          npm install
+          npm run build --if-present
+          npm test
+        env:
+          CI: true

.gitignore

@@ -75,3 +75,6 @@ dist
 
 # FuseBox cache
 .fusebox/
+
+# Misc.
+.DS_Store

README.md

@@ -52,7 +52,21 @@ const world = {
 const day1 = advance(world)
 ```
 
-You can also define custom rule functions.
+### Initializing a board
+
+A convenience function for initializing boards is included.
+
+```javascript
+import { initializeBoard, advance } from '@sondregj/conway'
+
+const genesis: Board = initializeBoard(64, 64, { random: true })
+
+const day1 = advance(genesis)
+```
+
+### Custom rule functions
+
+You can define custom rule functions.
 
 ```javascript
 import { advance } from '@sondregj/conway'
@@ -70,15 +84,7 @@ const rules = (board, cell, x, y) => !cell.alive
 const day1 = advance(world, rules)
 ```
 
-A convenience function for initializing boards is also included.
-
-```javascript
-import { initializeBoard, advance } from '@sondregj/conway'
-
-const genesis: Board = initializeBoard(64, 64, { random: true })
-
-const day1 = advance(genesis)
-```
+### TypeScript types
 
 The following TypeScript types are included.
 
@@ -103,4 +109,4 @@ const rules: RuleFunction = (board: Board, cell: Cell, x: number, y: number): bo
 
 ## License
 
-MIT © 2019 Sondre Gjellestad
+MIT © 2020 Sondre Gjellestad

jest.config.js

@@ -1,7 +1,7 @@
 module.exports = {
 	globals: {
 		'ts-jest': {
-			tsConfig: 'tsconfig.json'
+			tsconfig: 'tsconfig.json'
 		}
 	},
 	transform: {