From 66710b9e2e0b90656d8dfd3029975519202c3f0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sof=C3=ADa=20Aritz?= Date: Mon, 28 Aug 2023 22:40:06 +0000 Subject: [PATCH] Initial roadmap --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58d1a66..57f8565 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ -# pse-roadmap +# Personal Search Engine Roadmap -Roadmap for Personal Search Engine. \ No newline at end of file +> Confused? [Click here to learn more.](#what-is-pse) + +## Status +### In progress +- [Search modifiers](#search-modifiers) + +## Projects +### Search modifiers +Search modifiers are a simple way to improve and fine-tune your search. The current algorithm can show a lot of false-positives, +search modifiers will help you to specify metadata of the entry that must be exactly matching. + +Modifiers: +- `url:` - Partial URL of the entry (ex. `sofiaritz.com`, `sofiaritz.com/blog`). If no protocol is specified, any can match. +- `protocol:` - Protocol used in the URL of the entry (ex. `http`, `gemini`). +- `tags:` - Tags included in the entry. This is a comma-separated list. +- `added-after:` - Entry added after the given date. Date is in format DD/MM/YYYY +- `added-before:` - Entry added before the given date. Date is in format DD/MM/YYYY +- `visited:` - Visited the number of times specified in the matcher. The numbber matcher is one of the following: +`<`, `=`, `>` followed by a number. + +**Warning: Modifiers are subject to change** + +## What is PSE? + +PSE stands for _Personal Search Engine_, a simple AI-less personal search engine based on entries and content added by you. +The objective of PSE is to create a simple way to improve things like _bookmarks_ with simple algorithms that can be understood +by anyone. \ No newline at end of file