company-autocomplete/README.md

company-autocomplete

<p align="center">
  <a href="https://zhensherlock.github.io/company-autocomplete/" target="_blank" rel="noopener noreferrer">
    <img width="300" src="https://zhensherlock.github.io/company-autocomplete/hero-image.png" alt="watermark logo">
  </a>
</p>
<p align="center">
  <a href="https://npmjs.com/package/company-autocomplete"><img src="https://badgen.net/npm/v/company-autocomplete" alt="npm package"></a>
  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/zhensherlock/company-autocomplete/deploy.yml?branch=main">
  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/company-autocomplete">
  <img alt="npm download week" src="https://img.shields.io/npm/dw/company-autocomplete">
  <img alt="GitHub" src="https://img.shields.io/github/license/zhensherlock/company-autocomplete">
  <a href="https://gitter.im/china-hy/company-autocomplete?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/china-hy/company-autocomplete.svg" alt="Join the chat at https://gitter.im/china-hy/company-autocomplete"></a>
</p>

# Company Autocomplete

Works with both Vue 2 , Vue 3 And React.

# Translations

* [中文文档](README_zh.md)

## Installing

```bash
# or pnpm or yarn
npm install company-autocomplete
```

## Usage

### General

```ts
import { CompanyAutocomplete } from 'company-autocomplete'

const companyAutocomplete = new CompanyAutocomplete({
  target: '#example'
})
```

## Documentation

To learn more, check [its documentation](https://zhensherlock.github.io/company-autocomplete).

## Maintainers

[@zhensherlock](https://github.com/zhensherlock).

## Contributing

Feel free to dive in! [Open an issue](https://github.com/zhensherlock/company-autocomplete/issues/new/choose) or submit PRs.

Standard Readme follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) Code of Conduct.

### Contributors

This project exists thanks to all the people who contribute.

<a href="https://github.com/zhensherlock/company-autocomplete/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=zhensherlock/company-autocomplete" />
</a>

## License

[MIT](LICENSE) © MichaelSun