.gitignore + README.md reformat for better readability - Githubissues

cyberark / White-Phoenix

A tool to recover content from files encrypted with intermittent encryption

Apache License 2.0

214 stars 29 forks source link

.gitignore + README.md reformat for better readability #6

Closed 0xdavidel closed 12 months ago

0xdavidel commented 1 year ago

Desired Outcome

Improved readability and removed bloat

Implemented Changes

Improved readability of the readme
gave credit to the original article
changed the usage to a standardized format
added a .gitignore based on a public template for python development
emoved pycache files as they are redundant

Definition of Done

All mentioned changes have been implemented.

Changelog

[ ] The CHANGELOG has been updated, or
[x] This PR does not include user-facing changes and doesn't require a CHANGELOG update

Test coverage

[ ] This PR includes new unit and integration tests to go with the code changes, or
[x] The changes in this PR do not require tests

Documentation

[x] Docs (e.g. READMEs) were updated in this PR
[ ] A follow-up issue to update official docs has been filed here: [insert issue ID]
[ ] This PR does not require updating any documentation

Behavior

[ ] This PR changes product behavior and has been reviewed by a PO, or
[ ] These changes are part of a larger initiative that will be reviewed later, or
[x] No behavior was changed with this PR

Security

[ ] Security architect has reviewed the changes in this PR,
[ ] These changes are part of a larger initiative with a separate security review, or
[x] There are no security aspects to these changes