From 1c52eee14ec2ae7574d6b92b02dbdd9655a126d2 Mon Sep 17 00:00:00 2001 From: Petr Svenda Date: Fri, 17 Jul 2020 16:03:41 +0200 Subject: basic docs --- CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md | 10 ++++++++++ documentation.md | 5 +++++ 3 files changed, 15 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 documentation.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..e69de29b diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5a06ada3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +## Contributing + +You contribution is warmly welcomed. You can help by: + + 0. Spread the word about this project, look at generated processed webpages + 1. Trying the tool and reporting issues and suggestions for improvement (open Github issue) + 2. Add new regular expressions to extract relevant information from certificates (update cert_rules.py) + 3. Perform additional analysis with extracted data (analyze_certificates.py) + 3. Improve the code (TODO: Follow Github contribution guidelines, ideally contact us first about your plan) + diff --git a/documentation.md b/documentation.md new file mode 100644 index 00000000..cb1974f4 --- /dev/null +++ b/documentation.md @@ -0,0 +1,5 @@ +# sec-certs + +Analyzer of security certificates (Common Criteria, NIST FIPS140-2...) + +## Usage -- cgit v1.3.1