Update readme

.github/workflows/ci.yml

@@ -1,10 +1,24 @@
 name: CI
-on: [pull_request]
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - edited
+      - opened
+      - reopened
+      - synchronize
+
 jobs:
   audit:
     runs-on: ubuntu-latest
 
     steps:
+      - name: 'PR format check'
+        uses: 'androidx/check-pr-format-action'
+        with:
+          checks: '["(https:\/\/optimizely.atlassian.net\/browse\/){1}(DATA|DSSM){1}-{1}([0-9]+)"]'
+
       - uses: actions/checkout@v3
       - name: inspect
         run: |

README.md

@@ -0,0 +1,3 @@
+This is a rust based RESTfull service template. The main focus of this repo is to create a simple REST API that runs on a Salvo HTTP server and stores data in postgres using Diesel orm framework.
+
+Develoer can continue to create other rust based RESTfull service using this repo as a starting template.