Skip to content

Commit

Permalink
corrections in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
rumenvasilev committed Sep 6, 2023
1 parent 7e4a234 commit 65f673f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ To build from source, you need Go 1.21.
```

### Signatures
Signatures are the current method used to detect secrets within the a target source. They are broken out into the [rvsecret-signatures][4] repo for extensability purposes. This allows them to be independently versioned and developed without having to recompile the code. To makes changes just edit an existing signature or create a new one. Check the [README][5] in that repo for additional details.
Signatures are the current method used to detect secrets within a target source. They are broken out into the [wraith-signatures][4] repo for extensability purposes. This allows them to be independently versioned and developed without having to recompile the code. To make changes just edit an existing signature or create a new one. Check the [README][5] in that repo for additional details.

### Authencation
rvsecret will need either a GitLab or Github access token in order to interact with their appropriate API's. You can create a [GitLab personal access token][6], or [a Github personal access token][7] and save it in an environment variable in your **bashrc**, add it to a rvsecret config file, or pass it in on the command line. Passing it in on the commandline should be avoided if possible for security reasons. Of course if you want to eat your own dog food, go ahead and do it that way, then point rvsecret at your command history file. :smiling_imp:
Expand All @@ -73,8 +73,8 @@ Fork, PR and lets have a chat. Outstanding work is in [TODO.md](TODO.md).


[3]: https://github.com/rumenvasilev/rvsecret/releases
[4]: https://github.com/rumenvasilev/rvsecret-signatures
[5]: https://github.com/rumenvasilev/rvsecret-signatures/blob/master/README.md
[4]: https://github.com/rumenvasilev/wraith-signatures
[5]: https://github.com/rumenvasilev/wraith-signatures/blob/master/README.md
[6]: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
[7]: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/

Expand Down

0 comments on commit 65f673f

Please sign in to comment.