Skip to content

Commit

Permalink
docs: add env variable setup instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Khushiyant <khushiyant2002@gmail.com>
  • Loading branch information
Khushiyant committed May 26, 2024
1 parent 38faed3 commit 6d6de61
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,22 @@ Use the package manager [pip](https://pip.pypa.io/en/stable/) to install quasarp
```bash
pip install quasarpy
```
Since, quasrpy relies on hugging face for its online LLM reference, so it is required to set the environment variable `HUGGINGFACE_TOKEN` with the value of your hugging face token. You can get the token by signing up on [Hugging Face](https://huggingface.co/). You can use two of the following ways to setup the token:

- Using the `.env` file

```bash
mv .env.example .env

```

- Using the command Line

```bash
export HUGGINGFACE_TOKEN=<your_token>
```

```bash
### Command Line Interface

Quasar can be used as a command line tool to detect smells in a project. The command line interface can be used as follows:
Expand All @@ -52,4 +67,4 @@ We use [Sementic Versioning](http://semver.org/) for versioning the package rele

## License

This project is licensed under the GPL License - see the [LICENSE](https://github.com/Khushiyant/quasarpy/blob/164bc8d8ddfa32f8228fc886871b5a24429c61bb/LICENSE) file for details
This project is licensed under the GPL License - see the [LICENSE](https://github.com/Khushiyant/quasarpy/blob/164bc8d8ddfa32f8228fc886871b5a24429c61bb/LICENSE) file for details

0 comments on commit 6d6de61

Please sign in to comment.