Initial roadmap

This commit is contained in:
Sofía Aritz 2023-08-28 22:40:06 +00:00
parent 50726058ba
commit 66710b9e2e

View file

@ -1,3 +1,29 @@
# pse-roadmap
# Personal Search Engine Roadmap
Roadmap for Personal Search Engine.
> 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:<url>` - Partial URL of the entry (ex. `sofiaritz.com`, `sofiaritz.com/blog`). If no protocol is specified, any can match.
- `protocol:<protocol>` - Protocol used in the URL of the entry (ex. `http`, `gemini`).
- `tags:<tag-list>` - Tags included in the entry. This is a comma-separated list.
- `added-after:<date>` - Entry added after the given date. Date is in format DD/MM/YYYY
- `added-before:<date>` - Entry added before the given date. Date is in format DD/MM/YYYY
- `visited:<number-matcher>` - 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.