Skip to content

Commit

Permalink
Switch from JSDoc to TypeDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
lucaong committed Sep 19, 2020
1 parent 3447f02 commit bfb4634
Show file tree
Hide file tree
Showing 55 changed files with 3,453 additions and 12,062 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,15 @@ With `yarn`:
yarn add minisearch
```

Then `require` or `import` it in your project.
Then `require` or `import` it in your project:

```javascript
// If you are using import:
import MiniSearch from 'minisearch'

// If you are using require:
const MiniSearch = require('minisearch')
```

Alternatively, if you prefer to use a `<script>` tag, you can require MiniSearch
from a CDN:
Expand All @@ -71,6 +79,8 @@ from a CDN:
<script src="https://cdn.jsdelivr.net/npm/minisearch@2.6.0/dist/umd/index.min.js"></script>
```

In this case, `MiniSearch` will appear as a global variable in your project.

Finally, if you want to manually build the library, clone the repository and run
`yarn build` (or `yarn build-minified` for a minified version + source maps).
The compiled source will be created in the `dist` folder (UMD, ES6 and ES2015
Expand Down
Loading

0 comments on commit bfb4634

Please sign in to comment.