Skip to content

Commit 4f13732

Browse files
committed
Update README.md
1 parent ba301fc commit 4f13732

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<p align="center">
2-
<img src="assets/logo.svg" alt="MeiliSearch" width="200" height="200" />
2+
<img src="assets/logo.svg" alt="Meilisearch" width="200" height="200" />
33
</p>
44

55
<h1 align="center">docs-scraper</h1>
66

77
<h4 align="center">
8-
<a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
8+
<a href="https://github.com/meilisearch/Meilisearch">Meilisearch</a> |
99
<a href="https://docs.meilisearch.com">Documentation</a> |
1010
<a href="https://slack.meilisearch.com">Slack</a> |
1111
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
@@ -19,18 +19,18 @@
1919
<a href="https://app.bors.tech/repositories/28977"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2020
</p>
2121

22-
**docs-scraper** is a scraper for your documentation website that indexes the scraped content into a **MeiliSearch** instance.
22+
**docs-scraper** is a scraper for your documentation website that indexes the scraped content into a **Meilisearch** instance.
2323

24-
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
24+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/Meilisearch)
2525

26-
This scraper is used in production and runs on the [MeiliSearch documentation](https://docs.meilisearch.com/) on each deployment.
26+
This scraper is used in production and runs on the [Meilisearch documentation](https://docs.meilisearch.com/) on each deployment.
2727

28-
💡 If you already have your own scraper but you still want to use MeiliSearch and our [front-end tools](#-and-for-the-front-end-search-bar), check out [this discussion](https://github.com/meilisearch/docs-searchbar.js/issues/40).
28+
💡 If you already have your own scraper but you still want to use Meilisearch and our [front-end tools](#-and-for-the-front-end-search-bar), check out [this discussion](https://github.com/meilisearch/docs-searchbar.js/issues/40).
2929

3030
## Table of Contents <!-- omit in TOC -->
3131

3232
- [⚙️ Usage](#️-usage)
33-
- [Run your MeiliSearch Instance](#run-your-meilisearch-instance)
33+
- [Run your Meilisearch Instance](#run-your-meilisearch-instance)
3434
- [Set your Config File](#set-your-config-file)
3535
- [Run the Scraper](#run-the-scraper)
3636
- [🖌 And for the front-end search bar?](#-and-for-the-front-end-search-bar)
@@ -53,7 +53,7 @@ This scraper is used in production and runs on the [MeiliSearch documentation](h
5353
- [`allowed_domains` (optional)](#allowed_domains-optional)
5454
- [Authentication](#authentication)
5555
- [Installing Chrome Headless](#installing-chrome-headless)
56-
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
56+
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
5757
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
5858
- [Credits](#credits)
5959

@@ -62,27 +62,27 @@ This scraper is used in production and runs on the [MeiliSearch documentation](h
6262

6363
Here are the 3 steps to use `docs-scraper`:
6464

65-
1. [Run a MeiliSearch instance](#run-your-meilisearch-instance)
65+
1. [Run a Meilisearch instance](#run-your-meilisearch-instance)
6666
2. [Set your config file](#set-your-config-file)
6767
3. [Run the scraper](#run-the-scraper)
6868

69-
### Run your MeiliSearch Instance
69+
### Run your Meilisearch Instance
7070

71-
Your documentation content needs to be scraped and pushed into a MeiliSearch instance.
71+
Your documentation content needs to be scraped and pushed into a Meilisearch instance.
7272

73-
You can install and run MeiliSearch on your machine using `curl`.
73+
You can install and run Meilisearch on your machine using `curl`.
7474

7575
```bash
7676
curl -L https://install.meilisearch.com | sh
7777
./meilisearch --master-key=myMasterKey
7878
```
7979

80-
There are [other ways to install MeiliSearch](https://docs.meilisearch.com/learn/tutorials/getting_started.html#download-and-launch).
80+
There are [other ways to install Meilisearch](https://docs.meilisearch.com/learn/tutorials/getting_started.html#download-and-launch).
8181

82-
The host URL and the API key you will provide in the next steps correspond to the credentials of this MeiliSearch instance.
82+
The host URL and the API key you will provide in the next steps correspond to the credentials of this Meilisearch instance.
8383
In the example above, the host URL is `http://localhost:7700` and the API key is `myMasterKey`.
8484

85-
_MeiliSearch is open-source and can run either on your server or on any cloud provider. Here is a tutorial to [run MeiliSearch in production](https://docs.meilisearch.com/running-production/)._
85+
_Meilisearch is open-source and can run either on your server or on any cloud provider. Here is a tutorial to [run Meilisearch in production](https://docs.meilisearch.com/running-production/)._
8686

8787

8888
### Set your Config File
@@ -117,7 +117,7 @@ Here is an example of a basic config file:
117117
}
118118
}
119119
```
120-
The `index_uid` field is the index identifier in your MeiliSearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
120+
The `index_uid` field is the index identifier in your Meilisearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
121121

122122
The `docs-content` class (the `.` means this is a class) is the main container of the textual content in this example. Most of the time, this tag is a `<main>` or an `<article>` HTML element.
123123

@@ -163,7 +163,7 @@ docker run -t --rm \
163163

164164
`<absolute-path-to-your-config-file>` should be the absolute path of your configuration file defined at the [previous step](#set-your-config-file).
165165

166-
⚠️ If you run MeiliSearch locally, you must add the `--network=host` option to this Docker command.
166+
⚠️ If you run Meilisearch locally, you must add the `--network=host` option to this Docker command.
167167

168168
#### In a GitHub Action <!-- omit in TOC -->
169169

@@ -190,14 +190,14 @@ run-scraper:
190190
191191
⚠️ We do not recommend using the `latest` image in production. Use the [release tags](https://github.com/meilisearch/docs-scraper/releases) instead.
192192

193-
Here is the [GitHub Action file](https://github.com/meilisearch/documentation/blob/master/.github/workflows/gh-pages-scraping.yml) we use in production for the MeiliSearch documentation.
193+
Here is the [GitHub Action file](https://github.com/meilisearch/documentation/blob/master/.github/workflows/gh-pages-scraping.yml) we use in production for the Meilisearch documentation.
194194

195195
#### About the API Key <!-- omit in TOC -->
196196

197-
The API key you must provide should have the permissions to add documents into your MeiliSearch instance.<br>
197+
The API key you must provide should have the permissions to add documents into your Meilisearch instance.<br>
198198
In a production environment, we recommend providing the private key instead of the master key, as it is safer and it has enough permissions to perform such requests.
199199

200-
_More about [MeiliSearch authentication](https://docs.meilisearch.com/reference/features/authentication.html)._
200+
_More about [Meilisearch authentication](https://docs.meilisearch.com/reference/features/authentication.html)._
201201

202202
## 🖌 And for the front-end search bar?
203203

@@ -256,7 +256,7 @@ Your data will be displayed with a main title (`lvl0`), sub-titles (`lvl1`), sub
256256

257257
#### `index_uid`
258258

259-
The `index_uid` field is the index identifier in your MeiliSearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
259+
The `index_uid` field is the index identifier in your Meilisearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
260260

261261
```json
262262
{
@@ -411,7 +411,7 @@ This can be used to remove a table of content, a sidebar, or a footer, to make o
411411

412412
#### `custom_settings` (optional)
413413

414-
This field can be used to add MeiliSearch settings.
414+
This field can be used to add Meilisearch settings.
415415

416416
```json
417417
"custom_settings": {
@@ -528,9 +528,9 @@ If you set the environment variables `KC_URL`, `KC_REALM`, `KC_CLIENT_ID`, and `
528528
Websites that need JavaScript for rendering are passed through ChromeDriver.<br>
529529
[Download the version](http://chromedriver.chromium.org/downloads) suited to your OS and then set the environment variable `CHROMEDRIVER_PATH`.
530530

531-
## 🤖 Compatibility with MeiliSearch
531+
## 🤖 Compatibility with Meilisearch
532532

533-
This package only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0).
533+
This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/Meilisearch/releases/tag/v0.25.0).
534534

535535
## ⚙️ Development Workflow and Contributing
536536

@@ -545,4 +545,4 @@ Due to a lot of future changes on this repository compared to the original one,
545545

546546
<hr>
547547

548-
**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.
548+
**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.

0 commit comments

Comments
 (0)