Store and verify checksums of migration files (#16)

Author: Shpota

.eslintrc.json

@@ -7,11 +7,12 @@
     "overrides": [
     ],
     "parserOptions": {
-        "project": "./tsconfig.json",
+        "project": [ "./tsconfig.json", "./test/tsconfig.json"],
         "ecmaVersion": "latest",
         "sourceType": "module"
     },
     "rules": {
+        "@typescript-eslint/no-misused-promises": "off"
     },
     "ignorePatterns": ["dist/**/*"]
 }

.github/workflows/build.yaml

@@ -15,3 +15,5 @@ jobs:
         run: npm run build
       - name: Lint
         run: npm run lint
+      - name: Test
+        run: npm run test

README.md

@@ -1,8 +1,13 @@
-## Podil [![Build](https://github.com/podiljs/podil/actions/workflows/build.yaml/badge.svg)](https://github.com/podiljs/podil/actions/workflows/build.yaml) [![npm version](https://img.shields.io/npm/v/podil.svg?style=flat)](https://www.npmjs.com/package/podil) [![install size](https://packagephobia.com/badge?p=podil)](https://packagephobia.com/result?p=podil)
+## Podil [![Build](https://github.com/podiljs/podil/actions/workflows/build.yaml/badge.svg)](https://github.com/podiljs/podil/actions/workflows/build.yaml) [![npm version](https://img.shields.io/npm/v/podil.svg?style=flat)](https://www.npmjs.com/package/podil) [![install size](https://packagephobia.com/badge?p=podil)](https://www.npmjs.com/package/podil)
 
-<img src="https://raw.githubusercontent.com/podiljs/podil/main/.github/logo.svg" align="right" width="125px" alt="Podil logo">
+Lightweight and secure database migration tool for Node.js and Postgres. Podil lets
+you version your database by executing SQL scripts automatically on application
+startup. It keeps track of what scripts have been executed and what not which lets
+you seamlessly update your database schema on every environment in the same way. Podil
+saves you from mistakingly breaking your schema by storing and verifying checksums
+of every script that it executed. Podil strives at being simple and minimalistic,
+that's why it brings no dependencies except for Podil itself.
 
-Lightweight and secure database migration tool for Node.js and Postgres.
 
 ### How to use
 Install Podil and pg:
@@ -37,14 +42,19 @@ in the lexicographical order.
 
 ### Configuration
 
-By default, Podil looks for migrations in `./migrations`, you can pass a
-custom folder for migrations as a second argument to the `migrate()` call:
+Podil can be configured to look for migration scripts in an arbitrary location.
+By default, it looks for migrations in `./migrations`, you can pass a custom
+folder in the following way:
 
 ```shell
-await podil.migrate(
-  'postgres://podil:podil@localhost:5432/podil',
-  '/app/sql/migrations'
-);
+await podil.migrate(connectionString, { migrationsDir: '/path/to/your/migrations' });
+```
+
+It is recommended to verify the checksums of your scripts on every run. However,
+you can disable checksum verification using the `verifyChecksum` property:
+
+```shell
+await podil.migrate(connectionString, { verifyChecksum: false });
 ```
 
 ### Troubleshooting