You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing <!-- omit in toc -->
2
2
3
-
First of all, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to know in order to contribute to MeiliSearch and its different integrations.
3
+
First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
4
4
5
5
-[Assumptions](#assumptions)
6
6
-[How to Contribute](#how-to-contribute)
@@ -12,8 +12,8 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
12
12
## Assumptions
13
13
14
14
1.**You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
15
-
2.**You've read the MeiliSearch[documentation](https://docs.meilisearch.com) and the [README](/README.md).**
16
-
3.**You know about the [MeiliSearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
15
+
2.**You've read the Meilisearch[documentation](https://docs.meilisearch.com) and the [README](/README.md).**
16
+
3.**You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
17
17
18
18
## How to Contribute
19
19
@@ -30,14 +30,14 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
30
30
### Tests <!-- omit in toc -->
31
31
32
32
All the tests are documentation tests.<br>
33
-
Since they are all making operations on the MeiliSearch server, running all the tests simultaneously would cause panics.
33
+
Since they are all making operations on the Meilisearch server, running all the tests simultaneously would cause panics.
34
34
35
35
To run the tests one by one, run:
36
36
37
37
```bash
38
38
# Tests
39
-
curl -L https://install.meilisearch.com | sh # download MeiliSearch
40
-
./meilisearch --master-key=masterKey --no-analytics=true # run MeiliSearch
39
+
curl -L https://install.meilisearch.com | sh # download Meilisearch
40
+
./meilisearch --master-key=masterKey --no-analytics=true # run Meilisearch
41
41
cargo test -- --test-threads=1
42
42
```
43
43
@@ -122,7 +122,7 @@ Some notes on GitHub PRs:
122
122
123
123
## Release Process (for internal team only)
124
124
125
-
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
125
+
Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/).
126
126
127
127
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
<palign="center">⚡ The MeiliSearch API client written for Rust 🦀</p>
28
+
<palign="center">⚡ The Meilisearch API client written for Rust 🦀</p>
29
29
30
-
**MeiliSearch Rust** is the MeiliSearch API client for Rust developers.
30
+
**Meilisearch Rust** is the Meilisearch API client for Rust developers.
31
31
32
-
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
32
+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
33
33
34
34
## Table of Contents <!-- omit in TOC -->
35
35
36
36
-[📖 Documentation](#-documentation)
37
37
-[🔧 Installation](#-installation)
38
38
-[🚀 Getting Started](#-getting-started)
39
39
-[🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
40
-
-[🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
40
+
-[🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
41
41
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
42
42
43
43
## 📖 Documentation
@@ -65,23 +65,23 @@ You can enable the `sync` feature to make most structs `Sync`. It may be a bit s
65
65
66
66
Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde.
67
67
68
-
### Run a MeiliSearch Instance <!-- omit in TOC -->
68
+
### Run a Meilisearch Instance <!-- omit in TOC -->
69
69
70
-
This crate requires a MeiliSearch server to run.
70
+
This crate requires a Meilisearch server to run.
71
71
72
-
There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
72
+
There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
73
73
74
74
For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
75
75
76
76
```bash
77
-
# Install MeiliSearch
77
+
# Install Meilisearch
78
78
curl -L https://install.meilisearch.com | sh
79
79
80
-
# Launch MeiliSearch
80
+
# Launch Meilisearch
81
81
./meilisearch --master-key=masterKey
82
82
```
83
83
84
-
NB: you can also download MeiliSearch from **Homebrew** or **APT**.
84
+
NB: you can also download Meilisearch from **Homebrew** or **APT**.
@@ -232,13 +232,13 @@ This crate fully supports WASM.
232
232
233
233
The only difference between the WASM and the native version is that the native version has one more variant (`Error::Http`) in the Error enum. That should not matter so much but we could add this variant in WASM too.
234
234
235
-
However, making a program intended to run in a web browser requires a **very** different design than a CLI program. To see an example of a simple Rust web app using MeiliSearch, see the [our demo](./examples/web_app).
235
+
However, making a program intended to run in a web browser requires a **very** different design than a CLI program. To see an example of a simple Rust web app using Meilisearch, see the [our demo](./examples/web_app).
236
236
237
237
WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extension).
238
238
239
-
## 🤖 Compatibility with MeiliSearch
239
+
## 🤖 Compatibility with Meilisearch
240
240
241
-
This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
241
+
This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.24.0).
242
242
243
243
## ⚙️ Development Workflow and Contributing
244
244
@@ -248,4 +248,4 @@ If you want to know more about the development workflow or want to contribute, p
248
248
249
249
<hr>
250
250
251
-
**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
251
+
**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
<palign="center">⚡ The MeiliSearch API client written for Rust 🦀</p>
28
+
<palign="center">⚡ The Meilisearch API client written for Rust 🦀</p>
29
29
30
-
**MeiliSearch Rust** is the MeiliSearch API client for Rust developers.
30
+
**Meilisearch Rust** is the Meilisearch API client for Rust developers.
31
31
32
-
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
32
+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
33
33
34
34
## Table of Contents <!-- omit in TOC -->
35
35
36
36
- [📖 Documentation](#-documentation)
37
37
- [🔧 Installation](#-installation)
38
38
- [🚀 Getting Started](#-getting-started)
39
39
- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
40
-
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
40
+
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
41
41
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
42
42
43
43
## 📖 Documentation
@@ -65,23 +65,23 @@ You can enable the `sync` feature to make most structs `Sync`. It may be a bit s
65
65
66
66
Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde.
67
67
68
-
### Run a MeiliSearch Instance <!-- omit in TOC -->
68
+
### Run a Meilisearch Instance <!-- omit in TOC -->
69
69
70
-
This crate requires a MeiliSearch server to run.
70
+
This crate requires a Meilisearch server to run.
71
71
72
-
There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
72
+
There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
73
73
74
74
For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
75
75
76
76
```bash
77
-
# Install MeiliSearch
77
+
# Install Meilisearch
78
78
curl -L https://install.meilisearch.com | sh
79
79
80
-
# Launch MeiliSearch
80
+
# Launch Meilisearch
81
81
./meilisearch --master-key=masterKey
82
82
```
83
83
84
-
NB: you can also download MeiliSearch from **Homebrew** or **APT**.
84
+
NB: you can also download Meilisearch from **Homebrew** or **APT**.
85
85
86
86
{{readme}}
87
87
@@ -91,13 +91,13 @@ This crate fully supports WASM.
91
91
92
92
The only difference between the WASM and the native version is that the native version has one more variant (`Error::Http`) in the Error enum. That should not matter so much but we could add this variant in WASM too.
93
93
94
-
However, making a program intended to run in a web browser requires a **very** different design than a CLI program. To see an example of a simple Rust web app using MeiliSearch, see the [our demo](./examples/web_app).
94
+
However, making a program intended to run in a web browser requires a **very** different design than a CLI program. To see an example of a simple Rust web app using Meilisearch, see the [our demo](./examples/web_app).
95
95
96
96
WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extension).
97
97
98
-
## 🤖 Compatibility with MeiliSearch
98
+
## 🤖 Compatibility with Meilisearch
99
99
100
-
This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
100
+
This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.24.0).
101
101
102
102
## ⚙️ Development Workflow and Contributing
103
103
@@ -107,4 +107,4 @@ If you want to know more about the development workflow or want to contribute, p
107
107
108
108
<hr>
109
109
110
-
**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
110
+
**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
Copy file name to clipboardExpand all lines: examples/web_app/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Build your front-end page in Rust with WebAssembly
2
2
3
3
> **Note**
4
-
> It is not possible to run MeiliSearch in the browser without a server. This demo uses the Rust SDK in a browser using WASM, and communicate with a MeiliSearch instance that is running on a remote server.
4
+
> It is not possible to run Meilisearch in the browser without a server. This demo uses the Rust SDK in a browser using WASM, and communicate with a Meilisearch instance that is running on a remote server.
5
5
6
6
This example is a clone of [crates.meilisearch.com](https://crates.meilisearch.com), but the front-end is written in Rust!
7
7
The Rust source files are compiled into WebAssembly and so can be readable by the browsers.
0 commit comments