aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorPetr Svenda2020-07-17 16:03:41 +0200
committerPetr Svenda2020-07-17 16:03:41 +0200
commit1c52eee14ec2ae7574d6b92b02dbdd9655a126d2 (patch)
treeab7970729baa1d894cbf300fa080d4df39bcc048
parent289b46db3f5b9c0e81036a0521c2f08c3c7eb250 (diff)
downloadsec-certs-1c52eee14ec2ae7574d6b92b02dbdd9655a126d2.tar.gz
sec-certs-1c52eee14ec2ae7574d6b92b02dbdd9655a126d2.tar.zst
sec-certs-1c52eee14ec2ae7574d6b92b02dbdd9655a126d2.zip
basic docs
-rw-r--r--CODE_OF_CONDUCT.md0
-rw-r--r--CONTRIBUTING.md10
-rw-r--r--documentation.md5
3 files changed, 15 insertions, 0 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
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