typesense-docsearch-react - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "typesense-docsearch-react",
   "description": "React package for DocSearch, customized to work with Typesense",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
-  "homepage": "https://docsearch.algolia.com",
+  "homepage": "https://typesense.org/docs/latest/guide/docsearch.html",
   "repository": "typesense/docsearch.js",
@@ -8,0 +8,0 @@ "contributors": [

README.md

@@ -1,13 +0,19 @@
-# @docsearch/react
+# Typesense Docsearch React
 
-React package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
+This is a fork of Algolia's awesome [React-DocSearch](https://github.com/algolia/docsearch) library, customized to send queries to [Typesense](https://typesense.org).
 
-[![Percy](https://percy.io/static/images/percy-badge.svg)](https://percy.io/DX/DocSearch)
+To be able to use this, you'd first need to setup and run the [Typesense DocSearch Scraper](https://github.com/typesense/typesense-docsearch-scraper).
 
-## Installation
+#### What is Typesense?
 
+If you're new to Typesense, it is an **open source** search engine that is simple to use, run and scale, with clean APIs and documentation.
+
+Think of it as an open source alternative to Algolia and an easier-to-use, batteries-included alternative to ElasticSearch. Get a quick overview from [this guide](https://typesense.org/guide/).
+
+## Usage
+
 ```sh
-yarn add @docsearch/react@alpha
+yarn add typesense-docsearch-react
 # or
-npm install @docsearch/react@alpha
+npm install typesense-docsearch-react
 ```
@@ -17,2 +23,6 @@
 
-[Read documentation →](https://autocomplete-experimental.netlify.app/docs/DocSearch)
+Read detailed step-by-step instructions on how to configure and setup this version of DocSearch on Typesense's dedicated documentation site: https://typesense.org/docs/latest/guide/docsearch.html.
+
+## Help
+
+If you have any questions or run into any problems, please create a Github issue and we'll try our best to help.

No alert changes

Improved metrics

Total package byte prevSize

344051

increased by0.22%

Number of lines in readme file

28

increased by55.56%

No dependency changes