From aaed5e6cdfaebbb18b784b6e640d83f48e9917e2 Mon Sep 17 00:00:00 2001 From: Xevion Date: Tue, 26 Sep 2023 18:17:06 -0500 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4219b04..63659fa 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,21 @@ An experiment to try and find the ideal syntax highlighter for an arbitrary snip - Given a snippet of code, query the GitHub Markdown API to generate highlighted HTML. - Determine the complexity and level of color in the generated HTML. -- Report and display the results, showing the "best" syntax highlighter for the snippet. \ No newline at end of file +- Report and display the results, showing the "best" syntax highlighter for the snippet. + +## Goals + +- Memory caching of API results to prevent unnecessary requests. +- Automatic rate limiting and threading optimizations with Tokio, Governor, and Reqwest. +- GitHub Token & User-Agent compliance. +- Heuristics for determining the "best" syntax highlighter for per-request efficiency and overall speed. + +### Future + +- Provide a server with a nice user intreface for viewing the results using GitHub's syntax. + - [Light] & [Dark] mode options. + - OAuth login to allow users to view their own private repos. +- Ability to select parts of the text that should have no color + some color to fine-tune the results. + +[light]: https://github.com/primer/github-syntax-light/blob/master/lib/github-light.css +[dark]: https://github.com/primer/github-syntax-dark/blob/master/lib/github-dark.css