1
0
Fork 0

docs: update repository documentation

Closes #68
Closes #69
This commit is contained in:
François Chalifour 2020-08-25 14:18:30 +02:00
parent 85cdc5dbe3
commit fdb4b9fe78
2 changed files with 42 additions and 2 deletions

39
README.md Normal file
View file

@ -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
<link rel="stylesheet" href="https://unpkg.com/browse/@docsearch/css" />
```
#### 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';
```

View file

@ -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"