Skip to content

Commit

Permalink
Update documentation & add changelog entry
Browse files Browse the repository at this point in the history
  • Loading branch information
GCMarvin authored and cal4 committed Aug 23, 2024
1 parent 6b9a51a commit 2069c27
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- Support for automatic handling of time-based one-time password authentication

## [0.2.1] - 2024-08-13

### Fixed
Expand Down
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,28 @@

4. Edit the `accounts.json.sample` with your accounts credentials and rename it by removing `.sample` at the end.

The "totp" field is not mandatory, only enter your TOTP key if you use it for 2FA (if ommitting, don't keep
it as an empty string, remove the line completely).

The "proxy" field is not mandatory, you can omit it if you don't want to use proxy (don't keep it as an empty string,
remove the line completely).

- If you want to add more than one account, the syntax is the following:

```json
[
{
"username": "Your Email 1",
"password": "Your Password 1",
"proxy": "http://user:pass@host1:port"
},
{
"username": "Your Email 2",
"password": "Your Password 2",
"proxy": "http://user:pass@host2:port"
}
{
"username": "Your Email 1",
"password": "Your Password 1",
"totp": "0123 4567 89ab cdef",
"proxy": "http://user:pass@host1:port"
},
{
"username": "Your Email 2",
"password": "Your Password 2",
"totp": "0123 4567 89ab cdef",
"proxy": "http://user:pass@host2:port"
}
]
```

Expand Down

0 comments on commit 2069c27

Please sign in to comment.