diff --git a/README.md b/README.md index ef8e70b..749910a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,36 @@ # trans new tab page -https://diyhrt.market/api/ +I am using the api of [diyhrt.market](https://diyhrt.market/api/) to get the current stats data of estrogen stocks. + +# Installation + +To install the new tab page you can use `go install` + +```sh +go install gitea.elara.ws/Hazel/transfem-startpage +``` + +Then you can run the program `transfem-startpage` + +```sh +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. + +## Config and Profiles + +This tool works with profiles. The default profile is `startpage`. 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: + +- `{profile}.toml` +- `.{profile}.toml` +- `~/.config/startpage/{profile}.toml` + +If you have the server installed, you can start it with any profile by just doing: + +```sh +transfem-startpage {profile} +``` ## development @@ -11,14 +41,6 @@ https://diyhrt.market/api/ air dev ``` -## Config and Profiles - -This tool works with profiles. The default profile is `startpage`. 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: - -- `{profile}.toml` -- `.{profile}.toml` -- `~/.config/startpage/{profile}.toml` - ## TODO - implement ctl