snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2024-11-23 02:27:40 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Cleanup readme

Browse Source
This commit is contained in:
Thomas Payet 2020-07-02 16:16:53 +02:00
parent 982fb7b786
commit 476aecf86d
1 changed files with 27 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@ -2,7 +2,6 @@
<img src="assets/logo.svg" alt="MeiliSearch" width="200" height="200" /> <img src="assets/logo.svg" alt="MeiliSearch" width="200" height="200" />
</p> </p>
<h1 align="center">MeiliSearch</h1> <h1 align="center">MeiliSearch</h1>
<h4 align="center"> <h4 align="center">
@ -29,45 +28,43 @@
For more information about features go to [our documentation](https://docs.meilisearch.com/). For more information about features go to [our documentation](https://docs.meilisearch.com/).
<p align="center"> <p align="center">
<a href="https://crates.meilisearch.com"><img src="assets/crates-io-demo.gif" alt="crates.io demo gif" /></a> <img src="assets/movies-web-demo.gif" alt="Web interface gif" />
</p> </p>
> MeiliSearch helps the Rust community find crates on [crates.meilisearch.com](https://crates.meilisearch.com) ## ✨ Features
## Features
* Search as-you-type experience (answers < 50 milliseconds) * Search as-you-type experience (answers < 50 milliseconds)
* Full-text search * Full-text search
* Typo tolerant (understands typos and miss-spelling) * Typo tolerant (understands typos and miss-spelling)
* Faceted search and filters
* Supports Kanji characters * Supports Kanji characters
* Supports Synonym * Supports Synonym
* Easy to install, deploy, and maintain * Easy to install, deploy, and maintain
* Whole documents are returned * Whole documents are returned
* Highly customizable * Highly customizable
* RESTful API * RESTful API
* Faceted search and filtering
## Get started ## Getting started
### Deploy the Server ### Deploy the Server
#### Run it using Digital Ocean #### Brew (Mac OS)
[![DigitalOcean Marketplace](assets/do-btn-blue.svg)](https://marketplace.digitalocean.com/apps/meilisearch?action=deploy&refcode=7c67bd97e101)
#### Run it using Docker
```bash
docker run -p 7700:7700 -v $(pwd)/data.ms:/data.ms getmeili/meilisearch
```
#### Installing with Homebrew
```bash ```bash
brew update && brew install meilisearch brew update && brew install meilisearch
meilisearch meilisearch
``` ```
#### Installing with APT #### Docker
```bash
docker run -p 7700:7700 -v $(pwd)/data.ms:/data.ms getmeili/meilisearch
```
#### Run on Digital Ocean
[![DigitalOcean Marketplace](assets/do-btn-blue.svg)](https://marketplace.digitalocean.com/apps/meilisearch?action=deploy&refcode=7c67bd97e101)
#### APT (Debian & Ubuntu)
```bash ```bash
echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" > /etc/apt/sources.list.d/fury.list echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" > /etc/apt/sources.list.d/fury.list
@ -75,7 +72,7 @@ apt update && apt install meilisearch-http
meilisearch meilisearch
``` ```
#### Download the binary #### Download the binary (Linux & Mac OS)
```bash ```bash
curl -L https://install.meilisearch.com | sh curl -L https://install.meilisearch.com | sh
@ -165,33 +162,31 @@ We also deliver an **out-of-the-box web interface** in which you can test MeiliS
You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter MeiliSearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index. You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter MeiliSearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index.
<p align="center"> | [See the gif above](#demo)
<img src="assets/movies-web-demo.gif" alt="Web interface gif" />
</p>
### Documentation ## Documentation
Now that your MeiliSearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com). Now that your MeiliSearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com).
## Contributing ## Contributing
Hey! We're glad you're thinking about contributing to MeiliSearch! If you think something is missing or could be improved, please open issues and pull requests. If you'd like to help this project grow, we'd love to have you! To start contributing, checking [issues tagged as "good-first-issue"](https://github.com/meilisearch/MeiliSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is a good start! Hey! We're glad you're thinking about contributing to MeiliSearch! If you think something is missing or could be improved, please open issues and pull requests. If you'd like to help this project grow, we'd love to have you! To start contributing, checking [issues tagged as "good-first-issue"](https://github.com/meilisearch/MeiliSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is a good start!
### Analytic Events ## Telemetry
Every hour, events are being sent to our Amplitude instance so we can know how many people are using MeiliSearch.<br/> MeiliSearch collects anonymous data regarding general usage.
This helps us better understand developers usage of MeiliSearch features.<br/>
To see what information we're retrieving, please see the complete list [on the dedicated issue](https://github.com/meilisearch/MeiliSearch/issues/720).<br/> To see what information we're retrieving, please see the complete list [on the dedicated issue](https://github.com/meilisearch/MeiliSearch/issues/720).<br/>
We also use Sentry to make us crash and error reports. If you want to know more about what Sentry collects, please visit their [privacy policy website](https://sentry.io/privacy/).<br/> We also use Sentry to make us crash and error reports. If you want to know more about what Sentry collects, please visit their [privacy policy website](https://sentry.io/privacy/).<br/>
If this doesn't suit you, you can disable these analytics by using the `MEILI_NO_ANALYTICS` env variable. This program is optionnal, you can disable these analytics by using the `MEILI_NO_ANALYTICS` env variable.
## Contact ## 💌 Contact
Feel free to contact us about any questions you may have: Feel free to contact us about any questions you may have:
* At [bonjour@meilisearch.com](mailto:bonjour@meilisearch.com): English or French is welcome! 🇬🇧 🇫🇷 * At [bonjour@meilisearch.com](mailto:bonjour@meilisearch.com)
* Via the chat box available on every page of [our documentation](https://docs.meilisearch.com/) and on [our landing page](https://www.meilisearch.com/). * Via the chat box available on every page of [our documentation](https://docs.meilisearch.com/) and on [our landing page](https://www.meilisearch.com/).
* 🆕 Join our [GitHub Discussions forum](https://github.com/meilisearch/MeiliSearch/discussions) (BETA hype!) * 🆕 Join our [GitHub Discussions forum](https://github.com/meilisearch/MeiliSearch/discussions)
* Join our [Slack community](https://slack.meilisearch.com/). * Join our [Slack community](https://slack.meilisearch.com/).
* By opening an issue. * By opening an issue.
Any suggestion or feedback is highly appreciated. Thank you for your support! MeiliSearch is developed by [Meili](https://www.meilisearch.com), a young company. To know more about us, you can [read our blog](https://blog.meilisearch.com). Any suggestion or feedback is highly appreciated. Thank you for your support!