From 8076889f826a5f4d53acdd6d8e38161b8562fafc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Chalifour?= Date: Tue, 25 Aug 2020 14:18:30 +0200 Subject: [PATCH] docs: update repository documentation Closes #68 Closes #69 --- README.md | 15 +++++++++++++++ package.json | 5 +++-- 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..363a6bb7 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# @docsearch/js + +JavaScript package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs. + +## Installation + +```sh +yarn add @docsearch/js@alpha +# or +npm install @docsearch/js@alpha +``` + +## Documentation + +[Read documentation →](https://autocomplete-experimental.netlify.app/docs/DocSearch) diff --git a/package.json b/package.json index 5cb7a0d0..98dabdaa 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,10 @@ { "name": "@docsearch/js", + "description": "JavaScript 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"