Add Region type (#1)

* Add Region type

* fixes & docs

* make eslint happy

* add missing functions

* fixes

.github/workflows/ci.yml

@@ -21,15 +21,15 @@ jobs:
 
       # Install dependencies
       - name: Install dependencies
-        run: npm install
+        run: npm i
 
       # Run linter
       - name: Run Linter
         run: npm run lint
 
       # Check Prettier
       - name: Check Prettier
-        run: npm run prettier-check
+        run: npm run prettier
 
       # Run tests
       - name: Run Tests

README.md

@@ -1,3 +1,17 @@
 # coretime-utils
 
-An npm package containing types and constants that are commonly reused in regarding to Coretime
+An npm package containing types and constants that are commonly reused in relation to Coretime.
+
+### Usage
+
+Installation:
+
+```
+npm i coretime-utils
+```
+
+Types can be imported directly from the package, e.g.
+
+```js
+import { CoreMask } from 'coretime-utils';
+```