From 57ff86d84c70ad20d300c2bf78d9435da29bb19a Mon Sep 17 00:00:00 2001 From: Vladimir Kalnitsky Date: Thu, 1 Sep 2022 23:15:04 +0400 Subject: [PATCH 1/2] Update badge (#64) Co-authored-by: Fabrizio Ferrai --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9983496..736ab37 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # 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. @@ -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. From 83e10152f1aa9126a55b8b70aa441c0b6ff5ceb5 Mon Sep 17 00:00:00 2001 From: Vladimir Kalnitsky Date: Fri, 16 Aug 2024 22:37:42 +0400 Subject: [PATCH 2/2] Add a note about the merge with spago (#71) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 736ab37..b7e6092 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [![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) +**This project has been merged into the [spago codebase](https://github.com/purescript/spago/tree/master/docs-search)!** + 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.