From fdb4b9fe7842d2ef881d5d6a4873f3c7bf29f2cb 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 | 39 +++++++++++++++++++++++++++++++++++++++ package.json | 5 +++-- 2 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..876eae71 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# @docsearch/css + +Style package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs. + +## Installation + +In a JavaScript environment: + +```sh +yarn add @docsearch/css@alpha +# or +npm install @docsearch/css@alpha +``` + +## Usage + +### Import all styles + +#### In CSS + +```html + +``` + +#### In JavaScript + +```js +import '@docsearch/css'; +``` + +### Lazy-load styles + +```js +import '@docsearch/css/dist/_variables.css'; +import '@docsearch/css/dist/button.css'; + +// When needed +import '@docsearch/css/dist/modal.css'; +``` diff --git a/package.json b/package.json index 982c0c80..cca1c3d2 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,10 @@ { "name": "@docsearch/css", + "description": "Styles for DocSearch.", "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"