chore: add ci workflow and refine readme

.github/workflows/ci_build.yml

@@ -0,0 +1,35 @@
+name: ci-fsearch
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches:
+      - main
+      - dev-**
+  pull_request:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      # Install runtimes
+      - uses: actions/setup-go@v2
+        with:
+          go-version: "^1.18.0"
+      - run: go version
+      - name: unit tests & benchmarks
+        run: |
+          go test -bench=. ./...

README.md

@@ -1,8 +1,15 @@
 # Fsearch
-_An in-memory index which finds a keyword in millions of pathnames within microseconds._
+_An in-memory index which finds a keyword in millions of pathnames within milliseconds._
+
+<a href="https://github.com/ihexxa/fsearch/actions">
+    <img src="https://github.com/ihexxa/fsearch/workflows/ci-fsearch/badge.svg" />
+</a>
+<a href="https://goreportcard.com/report/github.com/ihexxa/fsearch">
+    <img src="https://goreportcard.com/badge/github.com/ihexxa/fsearch" />
+</a>
 
 ## Features
-- Fast: search a keyword in millions of directories in microseconds (see benchmark).
+- Fast: search a keyword in millions of directories within milliseconds (see benchmark).
 - Compact: indexing 1M pathnames with around 500MB memory.
 - Simple: less than 5 APIs