diff --git a/README.md b/README.md index 959c6b5e6ef5de78b25062b42ae911db8165e577..62b4368549799dda00310d467d395fde4471398c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,24 @@ -To use, go to https://products.wolframalpha.com/api/ and get a api key<br/> -Create a .env file in the root folder and add: APP_ID=your_api_key<br/> -run: "npm i" to install all dependencies<br/> -run: "node app.js search" or<br/> -run: "somethingThatOutputsToPipe | node app.js -p" (-p for pipe input)<br/> +# cli-wolframalpha + +App to use wolfram alpha from you command line + +## Usage + +### API-key + +To get API-key, go to [Wolframs website](https://products.wolframalpha.com/api/) + +Then, add the API-key as APP_ID to a .env file in the root directory + +### dependencies + +- dotenv +- node-fetch +- get-stdin + +You can install all dependencies by running `npm i` + +### commands + +- `node app.js search "your question"` +- `pipe output | node app.js -p`