diff --git a/README.md b/README.md index bde0a9f..1c85704 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,24 @@ This version of wfetch is semi-backwards compatible (config.toml will work! But ## Installation -Run the installer executible in root and follow instructions. +Fist download the latest release fron the releases page and extract it. Inside of the folder, you will see an executible named "wf-tool". +This will be the program that you will use to install and setup wfetch. + +Open your favorite terminal in the folder and run `sudo ./wf-tool -i` This will install wfetch. +> **WARNING**: You must run wf-tool with sudo to install wfetch. + +Wfetch should quickly install. After wfetch is installed, run `./wf-tool -s` and follow the setup instructions +> **WARNING**: Do not run this command under sudo. It will not let you run the setup if you do so. ## FAQ ### How do I get an Weather API key? First, go to the [Weather API](https://www.weatherapi.com/) website and then sign up. When finished creating an account, login then copy your api key. -Make sure to paste that api key to setup. ### Why don't you provide an api key? -I'm lazy. (plus api call limit stuff) +Giving out an api key is one of the top ten things to never do in your life. ## Contributing