From 1f7df2c7e004effd3d08ddfc0f7505e282115dd6 Mon Sep 17 00:00:00 2001 From: Vladimir Kalnitsky Date: Wed, 31 Aug 2022 22:35:55 +0300 Subject: [PATCH 1/2] Update badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9983496..7172e7a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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. From 0bf2262dcd34be14c8b985821a9cc569b9d857ae Mon Sep 17 00:00:00 2001 From: Vladimir Kalnitsky Date: Wed, 31 Aug 2022 22:39:01 +0300 Subject: [PATCH 2/2] Update usage instructions --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7172e7a..736ab37 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![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. @@ -10,7 +10,7 @@ It supports nearly-all functionality of [Pursuit](https://github.com/purescript/ 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 @@ -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.