Skip to content

Commit 587a106

Browse files
authored
docs: update readme (#105)
1 parent 3000af3 commit 587a106

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,8 @@ Managing content across multiple brands, regions, or business units often result
3838
## 🪄 Key Features
3939

4040
- **Cross-Site (Federated) Search:** Aggregate search results across multisite or standalone installations.
41-
- **Configurable Indexing:** Register which post types, taxonomies, or meta fields are searchable.
41+
- **Configurable Indexing:** Register which post types, taxonomies, or meta fields are searchable on a per-site basis.
4242
- **Custom Blocks:** Gutenberg-ready blocks for search interfaces.
43-
- **Brand-Specific Filtering:** Enable brand-based search scopes for multi-brand networks.
4443
- **Bring Your Own Key:** Connect it with your Algolia instance for improved data sovereignty and reduced vendor lock-in.
4544

4645
---
@@ -76,8 +75,8 @@ To connect your site with Algolia, follow these simple steps:
7675
4. Paste both keys into the `Dashboard > OneSearch > Settings` page under the 'Algolia Credentials' section.
7776

7877
### Configuring Indices and Search Scope
79-
> Indices: The data (post types) stored to make site content searchable.
80-
> Search Scope: Defines which sites can search or access other sites' indexed data.
78+
> **Indices**: The data (post types) stored to make site content searchable.
79+
> **Search Scope**: Defines which sites can search or access other sites' indexed data.
8180
8281
#### Configuring Indices
8382
1. Head to OneSearch > Indices and Search.
@@ -92,7 +91,7 @@ To connect your site with Algolia, follow these simple steps:
9291
## Development & Contributing
9392
OneSearch is under active development and maintained by [rtCamp](https://rtcamp.com).
9493

95-
Contributions are Welcome and encouraged! To learn more about contributing to OneSearch, please read the [Contributing Guide](https://github.com/rtCamp/OneSearch-internal/blob/main/docs/CONTRIBUTING.md).
94+
Contributions are welcome and encouraged! To learn more about contributing to OneSearch, please read the [Contributing Guide](https://github.com/rtCamp/OneSearch-internal/blob/main/docs/CONTRIBUTING.md).
9695

9796
For development guidelines, please refer to our [Development Guide](https://github.com/rtCamp/OneSearch-internal/blob/main/docs/DEVELOPMENT.md).
9897

@@ -107,7 +106,7 @@ No. Posts are automatically indexed when they are published, and removed when th
107106
Yes. Any updates made to a post are automatically synced with the Algolia index.
108107

109108
#### How are the search results ranked?
110-
Search results are ranked by Algolia's relevance algorithm. However, OneSearch boosts results from the current site you're searching on, ensuring more relevant local content appears first.
109+
Search results are ranked by Algolia's relevance algorithm. However, OneSearch boosts results from the current site you're searching on, ensuring more relevant local content appears first. You can further customize ranking and relevance through Algolia's dashboard.
111110

112111
## Get Involved
113112
You can join the development and discussions on [GitHub](https://github.com/rtCamp/OneSearch). Feel free to report issues, suggest features, or contribute code.

0 commit comments

Comments
 (0)