Skip to content

Commit

Permalink
fix: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
en9inerd committed Nov 15, 2023
1 parent f1ce8c5 commit 31e65bb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
1 change: 0 additions & 1 deletion Pipfile
Expand Up @@ -16,7 +16,6 @@ pytest = "*"
python-semantic-release = "*"
checksumdir = "*"
vulture = "*"
types-pyyaml = "*"

[packages]
docopt = "*"
Expand Down
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -15,7 +15,7 @@ To use TgEraser, you'll need to provide your API credentials, which you can obta

There are two methods to define `api_id` and `api_hash`:
1. Set them as environment variables (`TG_API_ID` and `TG_API_HASH`).
2. Allow the tool to prompt you for input during execution, with an option to save the credentials in a `credentials.json` file located in the same directory as the sessions.
2. Allow the tool to prompt you for input during execution, with an option to save the credentials in a `credentials.json` file located in the same directory as the sessions (by default, `~/.tgeraser/`).

## Usage

Expand Down Expand Up @@ -43,3 +43,7 @@ Options:
```

Executing the tool without options will guide you through the creation of your first user session. You can create sessions for multiple users using the `tgeraser session <new_session_name>` command.

## Contributing

If you have any issues or suggestions, please feel free to open an issue or submit a pull request.
1 change: 0 additions & 1 deletion requirements-dev.txt
Expand Up @@ -53,7 +53,6 @@ smmap==5.0.1; python_version >= '3.7'
toml==0.10.2; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2'
tomlkit==0.12.2; python_version >= '3.7'
twine==4.0.2; python_version >= '3.7'
types-pyyaml==6.0.12.12
typing-extensions==4.8.0; python_version >= '3.8'
urllib3==2.0.7; python_version >= '3.7'
vulture==2.10; python_version >= '3.8'
Expand Down

0 comments on commit 31e65bb

Please sign in to comment.