Amended README

cheatfate · Nov 5, 2018 · 922c493 · 922c493
1 parent 334ef0d
commit 922c493
Show file tree

Hide file tree

Showing 14 changed files with 21 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -53,3 +53,5 @@ packages/*
 .env
 examples/*
 !examples/*.nim
+tests/*
+!tests/*.nim
diff --git a/README.md b/README.md
@@ -2,4 +2,23 @@
 
 # Nim cryptographic library
 
+Nimcrypto is Nim's cryptographic library. It implements several popular cryptographic algorithms and their tests with some [examples](https://github.com/cheatfate/nimcrypto/tree/master/examples).
+
+Most notably, this library has been used in the [Nimbus Ethereum client](https://our.status.im/nimbus-for-newbies/). To see the implementation, check out its [Github repository](https://github.com/status-im/nimbus).
+
+
+## The most basic usage
+
+```bash
+nimble install nimcrypto # installation
+```
+
+```nim
+# example.nim
+import nimcrypto
+
+echo keccak_256.digest("Alice makes a hash") 
+# outputs EF0CC652868DF797522FB1D5A39E58E069154D9E47E5D7DB288B7200DB6EDFEE
+```
+
 See full documentation [here](https://cheatfate.github.io/nimcrypto).
diff --git a/tests/testapi b/tests/testapi
diff --git a/tests/testbcmode b/tests/testbcmode
diff --git a/tests/testblake2 b/tests/testblake2
diff --git a/tests/testblowfish b/tests/testblowfish
diff --git a/tests/testhmac b/tests/testhmac
diff --git a/tests/testkdf b/tests/testkdf
diff --git a/tests/testkeccak b/tests/testkeccak
diff --git a/tests/testrijndael b/tests/testrijndael
diff --git a/tests/testripemd b/tests/testripemd
diff --git a/tests/testsha2 b/tests/testsha2
diff --git a/tests/testsysrand b/tests/testsysrand
diff --git a/tests/testtwofish b/tests/testtwofish