Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
dinvlad committed Sep 2, 2020
1 parent 10ee398 commit f3cb698
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Python 3.7+

## Installation

```
pip3 install find-gcp-keys
```

## Usage

Expand All @@ -24,7 +26,7 @@ find_gcp_keys <dir_path>

As a library:

```
```py
from find_gcp_keys import find_key_paths, find_valid_keys, is_valid_key
...

Expand All @@ -33,10 +35,10 @@ if is_valid_key(file_path):
...

# recursively search for valid keys
for path in find_valid_keys(dir_path):
for file_path in find_valid_keys(dir_path):
...

# recursively search for possible keys, but don't validate them
for path in find_key_paths(dir_path):
for file_path in find_key_paths(dir_path):
...
```

0 comments on commit f3cb698

Please sign in to comment.