@@ -1,8 +1,8 @@
1# purescript-docs-search
1# purescript-docs-search
3−[](https://travis-ci.org/spacchetti/purescript-docs-search)
3+[](https://github.com/purescript/purescript-docs-search/actions/workflows/build.yml)
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.
7It supports nearly-all functionality of [Pursuit](https://github.com/purescript/pursuit), including querying by type.
7It supports nearly-all functionality of [Pursuit](https://github.com/purescript/pursuit), including querying by type.
@@ -10,7 +10,7 @@ It supports nearly-all functionality of [Pursuit](https://github.com/purescript/
11When using [spago](https://github.com/spacchetti/spago), you don't need to install this app manually: run `spago docs` or `spago search`.
11When using [spago](https://github.com/spacchetti/spago), you don't need to install this app manually: run `spago docs` or `spago search`.
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`.
@@ -45,4 +45,4 @@ npm install
45npm run build # or build-dev to skip JS compression stage
45npm run build # or build-dev to skip JS compression stage
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.