layed out the basics on how

This commit is contained in:
Hazel Noack 2025-07-16 10:41:36 +02:00
parent 60f5495f79
commit f6558e3cd7

View File

@ -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. 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` 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. 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 ## 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: 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: