Skip to content

Clarify installation and development instructions #36

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

Merged
merged 1 commit into from
Jul 8, 2020
Merged

Clarify installation and development instructions #36

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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ It supports nearly-all functionality of [Pursuit](https://github.com/purescript/

## Installing

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

When using [spago](https://github.com/spacchetti/spago), you don't need to install this app. Just run `spago docs` or `spago search`.
Otherwise, use [npx](https://github.com/npm/npx): `npx purescript-docs-search`.

## Usage

Expand All @@ -37,3 +37,12 @@ A quick demo:
[![asciicast](https://asciinema.org/a/Hexie5JoWjlAqLqv2IgafIdb9.svg)](https://asciinema.org/a/Hexie5JoWjlAqLqv2IgafIdb9)

You may notice that the CLI offers slightly better results than the web interface. This is a performance tradeoff.

## Development

```
npm install
npm run build # or build-dev to skip JS compression stage
```

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.