From 24da77b30ffd81d040c7d24636d971b4f7c6275f Mon Sep 17 00:00:00 2001 From: tison Date: Mon, 18 Nov 2024 19:03:41 +0800 Subject: [PATCH] chore: fix README badge and typos Signed-off-by: tison --- .github/workflows/ci.yml | 6 +++--- README.md | 10 +++------- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a782751..8efef55 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: ci +name: CI on: pull_request: branches: @@ -11,9 +11,9 @@ on: # The section is needed to drop write-all permissions that are granted on # `schedule` event. By specifying any permission explicitly all others are set -# to none. By using the principle of least privilege the damage a compromised +# to none. By using the principle of the least privilege the damage a compromised # workflow can do (because of an injection or compromised third party tool or -# action) is restricted. Currently the worklow doesn't need any additional +# action) is restricted. Currently, the workflow doesn't need any additional # permission except for pulling the code. Adding labels to issues, commenting # on pull-requests, etc. may need additional permissions: # diff --git a/README.md b/README.md index 308907f..75ff6d4 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,11 @@ Check out my blog post Rust](https://blog.burntsushi.net/transducers/) for extensive background, examples and experiments. -[![Build status](https://github.com/BurntSushi/fst/workflows/ci/badge.svg)](https://github.com/BurntSushi/fst/actions) -[![](https://meritbadge.herokuapp.com/fst)](https://crates.io/crates/fst) +[![CI](https://github.com/BurntSushi/fst/actions/workflows/ci.yml/badge.svg)](https://github.com/BurntSushi/fst/actions/workflows/ci.yml) +[![Crates.io](https://img.shields.io/crates/v/fst.svg)](https://crates.io/crates/fst) Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org/). - ### Documentation https://docs.rs/fst @@ -28,7 +27,6 @@ crate provides implementations of the `fst::Automata` trait when its `transducer` feature is enabled. This permits using DFAs compiled by `regex-automata` to search finite state transducers produced by this crate. - ### Installation Simply add a corresponding entry to your `Cargo.toml` dependency list: @@ -38,7 +36,6 @@ Simply add a corresponding entry to your `Cargo.toml` dependency list: fst = "0.4" ``` - ### Example This example demonstrates building a set in memory and executing a fuzzy query @@ -68,9 +65,8 @@ fn main() -> Result<(), Box> { Check out the documentation for a lot more examples! - ### Cargo features * `levenshtein` - **Disabled** by default. This adds the `Levenshtein` - automaton to the `automaton` sub-module. This includes an additional + automaton to the `automaton` submodule. This includes an additional dependency on `utf8-ranges`.