Skip to content

Update badge #64

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 3 commits into from
Sep 1, 2022
Merged

Update badge #64

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f7df2c
Update badge
klntsky Aug 31, 2022
0bf2262
Update usage instructions
klntsky Aug 31, 2022
5c08479
Merge branch 'master' into klntsky-patch-1
f-f Sep 1, 2022
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# purescript-docs-search

[![Build status](https://travis-ci.org/spacchetti/purescript-docs-search.svg?branch=master)](https://travis-ci.org/spacchetti/purescript-docs-search)
[![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)

An app that adds search capabilities to generated documentation for purescript code.
An app that adds search capabilities to generated documentation for PureScript code.

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

## Installing

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

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

## Usage

Expand Down Expand Up @@ -45,4 +45,4 @@ 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.
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.