git.iko.soy/rowtype-yoga/purescript-docs-search
on master help sign in
Clarify installation and development instructions (#36)
commitb1f9554b8dc833fd9df2a47841031331c096b99e authorVladimir Kalnitsky <klntsky@gmail.com> dateWed 8 Jul 2020, 12:17 (6 years ago) parent7c7179d
1 file changed+11−2
README.md+11−2
README.md+11−2
@@ -8,9 +8,9 @@ It supports nearly-all functionality of [Pursuit](https://github.com/purescript/
88
99## Installing
1010
11−Run `npm install purescript-docs-search`.
11+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−When using [spago](https://github.com/spacchetti/spago), you don't need to install this app. Just run `spago docs` or `spago search`.
13+Otherwise, use [npx](https://github.com/npm/npx): `npx purescript-docs-search`.
1414
1515## Usage
1616
@@ -37,3 +37,12 @@ A quick demo:
3737[![asciicast](https://asciinema.org/a/Hexie5JoWjlAqLqv2IgafIdb9.svg)](https://asciinema.org/a/Hexie5JoWjlAqLqv2IgafIdb9)
3838
3939You may notice that the CLI offers slightly better results than the web interface. This is a performance tradeoff.
40+
41+## Development
42+
43+```
44+npm install
45+npm run build # or build-dev to skip JS compression stage
46+```
47+
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.