Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix README badge and typos #174

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: fix README badge and typos #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ci
name: CI
on:
pull_request:
branches:
Expand All @@ -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:
#
Expand Down
10 changes: 3 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -68,9 +65,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {

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`.