diff --git a/README.md b/README.md new file mode 100644 index 00000000..c48f0f6f --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# @docsearch/react + +React package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs. + +[![Percy](https://percy.io/static/images/percy-badge.svg)](https://percy.io/DX/DocSearch) + +## Installation + +```sh +yarn add @docsearch/react@alpha +# or +npm install @docsearch/react@alpha +``` + +## Documentation + +[Read documentation →](https://autocomplete-experimental.netlify.app/docs/DocSearch) diff --git a/package.json b/package.json index 21924afe..c4e5a42d 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,10 @@ { "name": "@docsearch/react", + "description": "React package for DocSearch, the best search experience for docs.", "version": "1.0.0-alpha.27", "license": "MIT", - "homepage": "https://github.com/algolia/autocomplete.js", - "repository": "algolia/autocomplete.js", + "homepage": "https://github.com/francoischalifour/autocomplete.js", + "repository": "francoischalifour/autocomplete.js", "author": { "name": "Algolia, Inc.", "url": "https://www.algolia.com"