mirror of https://github.com/CIRCL/PyCIRCLean
Clarify language in README
parent
dc76e00554
commit
3cc9aa23f2
14
README.md
14
README.md
|
@ -22,8 +22,9 @@ pip install .
|
||||||
|
|
||||||
# How to use PyCIRCLean
|
# How to use PyCIRCLean
|
||||||
|
|
||||||
PyCIRCLean is a simple Python library to handle file checking and sanitization. PyCIRCLean is designed as a simple library
|
PyCIRCLean is a simple Python library to handle file checking and sanitization.
|
||||||
that can be overloaded to cover specific checking and sanitization workflows in different organizations like industrial
|
PyCIRCLean is designed to be overloaded and extended to cover specific checking
|
||||||
|
and sanitization workflows in different organizations such as industrial
|
||||||
environments or restricted/classified ICT environments. A series of practical examples utilizing PyCIRCLean can be found
|
environments or restricted/classified ICT environments. A series of practical examples utilizing PyCIRCLean can be found
|
||||||
in the [./examples](./examples) directory.
|
in the [./examples](./examples) directory.
|
||||||
|
|
||||||
|
@ -125,9 +126,12 @@ if __name__ == '__main__':
|
||||||
|
|
||||||
# How to contribute
|
# How to contribute
|
||||||
|
|
||||||
We welcome contributions (including bug fixes, new code workflows) via pull requests. We are interested in any new workflows
|
We welcome contributions (including bug fixes, new example file processing
|
||||||
that can be used to improve security in different organizations. If you see any potential enhancements required to support
|
workflows) via pull requests. We are particularly interested in any new workflows
|
||||||
your sanitization workflow, please feel free to open an issue. Read [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.
|
that can be used to improve security in different organizations. If you see any
|
||||||
|
potential enhancements required to support your sanitization workflow, please feel
|
||||||
|
free to open an issue. Read [CONTRIBUTING.md](/CONTRIBUTING.md) for more
|
||||||
|
information.
|
||||||
|
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
Loading…
Reference in New Issue