From d5cfaa9b957800bb828fb322d19da452d8ea8e35 Mon Sep 17 00:00:00 2001 From: Brian Huisman Date: Fri, 17 May 2024 11:39:10 -0400 Subject: [PATCH] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 30946de..cfb9764 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ ![orcinus-banner](https://github.com/GreyWyvern/orcinus-search/assets/137631/d504de08-3029-4e68-acf5-1dd1e5008674) -The **Orcinus Site Search** PHP script is an all-in-one website crawler, indexer and search engine that extracts searchable content from plain text, XML, HTML and PDF files at a single, or multiple websites. It replaces 3rd party, remote search solutions such as Google etc. +The **Orcinus Site Search** PHP script is an all-in-one website crawler, indexer and search engine that extracts searchable content via HTTP/HTTPS from plain text, XML, HTML and PDF files at a single, or multiple websites. It replaces 3rd party, remote search solutions such as Google etc. -**Orcinus** will crawl your website content on a schedule, or at your command via the admin UI or even by CLI / crontab. Crawler log output conveniently informs you of missing pages, broken links or links that redirect, and other errors that a webmaster can fix to keep the user experience tight. A full-featured, responsive administration GUI allows you to adjust crawl settings, view and edit all crawled pages, customize search results, and view a log of user search queries. You also have complete control over the appearance of your search results with a [convenient templating system](https://mustache.github.io/). +**Orcinus** will crawl your website content on a schedule, or at your command via the admin UI or even by CLI / crontab. Crawler log output conveniently informs you of missing pages, broken links or links that redirect, and other errors that a webmaster can fix to keep the user experience tight. A full-featured, Bootstrap-based responsive administration GUI allows you to adjust crawl settings, view and edit all crawled pages, customize search results, and view a log of user search queries. You also have complete control over the appearance of your search results with a [convenient templating system](https://mustache.github.io/). Optionally, **Orcinus** can generate a [sitemap .xml or .xml.gz](https://www.sitemaps.org) file of your pages after every crawl, suitable for uploading to the [Google Search Console](https://search.google.com/search-console/sitemaps). It can also export a JavaScript version of the entire search engine that works with offline mirrors, such as those generated by [HTTrack](https://www.httrack.com). @@ -30,6 +30,6 @@ Optional: 1. Copy the `orcinus` directory to your root web directory. 2. Fill out your SQL and desired credential details in the `orcinus/config.ini.php` file. 3. Visit `yourdomain.com/orcinus/admin.php` in your favourite web browser and log in. -4. Optionally follow the instructions in `orcinus/geoip2/README.md` to enable geolocation of search queries. +4. Optionally follow the instructions in [`orcinus/geoip2/README.md`](https://github.com/GreyWyvern/orcinus-search/blob/main/orcinus/geoip2/README.md) to enable geolocation of search queries. Examples of search interface integration are given in the `example.php` (online / PHP) and `example.html` (offline / JavaScript) files.