Skip to content

Commit

Permalink
Add documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
chr15m committed Jun 13, 2020
1 parent 5126425 commit 262eafe
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Optional arguments:

`is_outdated` is a boolean which is True if the given version is earlier than the latest version, which is the string `latest_version`.

Optional arguments:

- `repository_url` (default `https://pypi.python.org/pypi/%s/json`): format string to use a different repository pypi repository URL. For example test.pypi.org or a private repository. Formatter is passed the package name as the first argument.

This still makes the HTTP call with retries and caches the result on disk. It doesn't use a separate thread or emit any warnings (unless there is an exception specifically while using the cache, in which case the check will be done without the cache).

## Additional configuration
Expand Down

0 comments on commit 262eafe

Please sign in to comment.