From 41ce1a02fb99242644145366e197c8fd2e9f17c0 Mon Sep 17 00:00:00 2001 From: Jia He Date: Sat, 9 Jul 2022 18:23:26 +0800 Subject: [PATCH] chore: add ci workflow and refine readme --- .github/workflows/ci_build.yml | 35 ++++++++++++++++++++++++++++++++++ README.md | 11 +++++++++-- 2 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/ci_build.yml diff --git a/.github/workflows/ci_build.yml b/.github/workflows/ci_build.yml new file mode 100644 index 0000000..eb1697b --- /dev/null +++ b/.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=. ./... diff --git a/README.md b/README.md index 13adf72..bf527ba 100644 --- a/README.md +++ b/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._ + + + + + + + ## 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