Skip to content

Commit 57ff86d

Browse files
klntskyf-f
andauthored
Update badge (#64)
Co-authored-by: Fabrizio Ferrai <fabrizio.ferrai@gmail.com>
1 parent 2e294fb commit 57ff86d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# purescript-docs-search
22

3-
[![Build status](https://travis-ci.org/spacchetti/purescript-docs-search.svg?branch=master)](https://travis-ci.org/spacchetti/purescript-docs-search)
3+
[![Build status](https://github.com/purescript/purescript-docs-search/actions/workflows/build.yml/badge.svg)](https://github.com/purescript/purescript-docs-search/actions/workflows/build.yml)
44

5-
An app that adds search capabilities to generated documentation for purescript code.
5+
An app that adds search capabilities to generated documentation for PureScript code.
66

77
It supports nearly-all functionality of [Pursuit](https://github.com/purescript/pursuit), including querying by type.
88

99
## Installing
1010

1111
When using [spago](https://github.com/spacchetti/spago), you don't need to install this app manually: run `spago docs` or `spago search`.
1212

13-
Otherwise, use [npx](https://github.com/npm/npx): `npx purescript-docs-search`.
13+
Otherwise, use NPM (`npm install purescript-docs-search`) or [npx](https://github.com/npm/npx): `npx purescript-docs-search`.
1414

1515
## Usage
1616

@@ -45,4 +45,4 @@ npm install
4545
npm run build # or build-dev to skip JS compression stage
4646
```
4747

48-
Use `spago docs --no-search && ./dist/purescript-docs-search build-index` to generate the docs and patch them using the local version of the app.
48+
Use `spago docs --no-search && ./dist/purescript-docs-search.cjs build-index` to generate the docs and patch them using the local version of the app.

0 commit comments

Comments
 (0)