Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
vbkaisetsu committed Sep 28, 2022
1 parent 9c990a4 commit 1a7f408
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
[daachorse](https://github.com/daac-tools/daachorse) is a fast implementation of the Aho-Corasick algorithm using the compact double-array data structure.
This is a Python wrapper.

[![PyPI](https://img.shields.io/pypi/v/daachorse)](https://pypi.org/project/daachorse/)
[![Build Status](https://github.com/vbkaisetsu/python-daachorse/actions/workflows/CI.yml/badge.svg)](https://github.com/vbkaisetsu/python-daachorse/actions)

## Installation

To use daachorse, run the following command:
Expand All @@ -11,6 +14,14 @@ To use daachorse, run the following command:
$ pip install daachorse
```

You can also build a package as follows:

```
$ python3 -m pip install maturin # installs maturin
$ python3 -m maturin build --release -o dist # whl file is placed in dist
$ python3 -m pip install dist/*.whl # installs daachorse
```

## Example usage

Daachorse contains some search options,
Expand Down

0 comments on commit 1a7f408

Please sign in to comment.