From f6558e3cd7624d3fe25dbad9b03812ebabc6f8b3 Mon Sep 17 00:00:00 2001 From: Hazel Noack Date: Wed, 16 Jul 2025 10:41:36 +0200 Subject: [PATCH] layed out the basics on how --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8b267a9..1fcb891 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ I am using the api of [diyhrt.market](https://diyhrt.market/api/) to get the current stats data of estrogen stocks. -# Installation +## Installation To install the new tab page you can use `go install` @@ -18,6 +18,18 @@ transfem-startpage To configure this new tab page as website, you can install the firefox extension [New Tab Override](https://addons.mozilla.org/en-US/firefox/addon/new-tab-override/). Then just configure the url as `http://127.0.0.1:{port}/`. The default port should be `5500` but it will also print it out when starting the server. Make sure to check the box `Set focus to the web page instead of the address bar` in the extension settings, because the new tab page auto focuses the search bar. +## CLI + +```sh +transfem-startpage {program} {...args} +``` + +program | args | description +---|---|--- +`help` | `program:optional` | get more information on how the cli or one program works +`start` | `profile:optional` | start the webserver for a certain profile +`cache` | `action:emum(clear;clean)` | so something with the cache + ## Config and Profiles This tool works with profiles. The default profile is `default`. If you want to load another profile just write it as command line arg after the command. To write a config File you can create the files here: