update the readme file and action name (#4)

Author: agneum

README.md

@@ -11,4 +11,54 @@ A GitHub action to run DB migrations with Database Lab Engine (DLE)
 - Protect logs and artifacts from being revealed
 
 ## How to use
-Check out the [Database Lab DB migrations checker documentation](https://postgres.ai/docs/db-migration-checker)
+To use the action, create a yml file in the `.github/workflows/` directory.
+
+Copy and paste the installation snippet from the [Marketplace page](https://github.com/marketplace/actions/database-lab-migration-checker) into your .yml file.
+
+Check out the [Database Lab DB migrations checker documentation](https://postgres.ai/docs/db-migration-checker) to learn how it works and see available configuration options
+
+For example,
+
+```yaml
+on: [ push ]
+
+jobs:
+  migration_job:
+    runs-on: ubuntu-latest
+    name: CI migration
+    steps:
+      # Checkout the source code
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # Run database migrations with the public action
+      - name: Check database migrations with DLE
+        uses: postgres-ai/[email protected]
+        id: db-migrations
+        with:
+          dbname: test
+          commands: |
+            sqitch deploy
+            echo 'Migration has been completed'
+          download_artifacts: true
+          observation_interval: "10"
+          max_lock_duration: "1"
+          max_duration: "600"
+        env:
+          DLMC_CI_ENDPOINT: ${{ secrets.DLMC_CI_ENDPOINT }}
+          DLMC_VERIFICATION_TOKEN: ${{ secrets.DLMC_VERIFICATION_TOKEN }}
+
+      # Download artifacts
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: artifacts
+          path: artifacts/*
+          if-no-files-found: ignore
+        if: always()
+
+      # Show migration summary
+      - name: Get the response status
+        run: echo "${{ steps.db-migrations.outputs.response }}"
+
+```

action.yml

@@ -1,5 +1,5 @@
-name: 'DB migrations checker with DLE'
-description: 'Run DB migrations with the DLE'
+name: 'Database Lab migration checker'
+description: 'Check database migrations with the Database Lab Engine'
 inputs:
   owner:
     description: 'The owner of the repository to check'
@@ -59,7 +59,7 @@ inputs:
 
 outputs:
   response:
-    description: 'The result of CI checks'
+    description: 'The result of migration checks'
 runs:
   using: 'docker'
   image: 'Dockerfile'