From b492b3eeac553e6d8136ed7cbbde1afa7b788bc2 Mon Sep 17 00:00:00 2001 From: Brian Huisman Date: Thu, 20 Apr 2023 10:46:20 -0400 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index daf38c1..b14edb4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,20 @@ # Orcinus Site Search -The Orcinus Site Search PHP script is an all-in-one site crawler and search engine. Designed for use with small to medium sized sites without a convenient CMS search feature, it replaces 3rd party search solutions such as Google etc. +The Orcinus Site Search PHP script is an all-in-one website crawler and search engine that extracts searchable content from XML, HTML and PDF files from a single, or multiple websites. It replaces 3rd party, remote search solutions such as Google etc. -Orcinus will crawl your site content on a schedule, or at your command via the admin UI or even by CLI/crontab. Customize your search results by blocking URLs, unlisting pages, or raising/lowering their search priority. +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, links that redirect, and other errors that you, as a webmaster can fix to keep your user experience tight. Customize your search results by blocking URLs, unlisting pages, or raising/lowering their search priority. You have complete control over the appearance of your search results with a [convenient templating system](https://mustache.github.io/). -Orcinus can generate a sitemap XML file of your pages after every crawl, suitable for uploading to Google analytics. It can also export a JavaScript version of the search engine that works with offline mirrors, such as those generated by HTTrack. +Orcinus can generate a [sitemap XML or XML.GZ](https://www.sitemaps.org) file of your pages after every crawl, suitable for uploading to Google analytics. 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). Requires: - PHP >= 7.2.x - MySQL / MariaDB + +3rd Party Libraries Included: +- [PHPMailer](https://github.com/PHPMailer/PHPMailer) +- [PDFParser](https://github.com/smalot/pdfparser) +- [Mustache](https://github.com/bobthecow/mustache.php) / [Mustache.js](https://github.com/janl/mustache.js) +- [libcurlemu](https://github.com/m1k3lm/libcurlemu) + +Optional Libraries: +- [Maxmind GeoIP2](https://github.com/maxmind/GeoIP2-php)