diff --git a/README.md b/README.md index eaa4b6c9308cfa1ce9d9fe6bc63fcafe2c846cb9..677f1ab8af57ac1dad64c35bfbd332c667cfecee 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# libSAEDEA +# libsaedea Nim Library implementing a variation of Simple And Efficient Data Encryption Algorithm Research paper pdf: [INTERNATIONAL JOURNAL OF SCIENTIFIC & TECHNOLOGY RESEARCH VOLUME 8, ISSUE 12, DECEMBER 2019 ISSN 2277-8616](http://www.ijstr.org/final-print/dec2013/A-Survey-On-Some-Encryption-Algorithms-And-Verification-Of-Rsa-Technique.pdf) from [IJSTR.org](https://www.ijstr.org/paper-references.php?ref=IJSTR-1119-24664) # Usage: -`import libSAEDEA` +`import libsaedea` `gen_iv("your random data: string")` => gives you an Initialization Vector (type: string) @@ -13,19 +13,19 @@ Research paper pdf: [INTERNATIONAL JOURNAL OF SCIENTIFIC & TECHNOLOGY RESEARCH V ## SAEDEA complete implementation -`ecrypt("your cleartext data: string", "the shared secret: string", "initialization vector: string", "length of the cleartext data: int")` +`saedea_ecrypt("your cleartext data: string", "the shared secret: string", "initialization vector: string", "length of the cleartext data: int")` => gives the encrypted data (type: string) -`decrypt("the encrypted string", "the shared secret: string", "initialization vector: string", "length of the cleartext data: int")` +`saedea_decrypt("the encrypted string", "the shared secret: string", "initialization vector: string", "length of the cleartext data: int")` => gives the cleartext data (type: string) ## SAEDEA light implementation -`ecrypt("your cleartext data: string", "the shared secret: string", "initialization vector: string")` +`saedea_ecrypt("your cleartext data: string", "the shared secret: string", "initialization vector: string")` => gives the encrypted data (type: string) -`decrypt("the encrypted string", "the shared secret: string", "initialization vector: string")` +`saedea_decrypt("the encrypted string", "the shared secret: string", "initialization vector: string")` => gives the cleartext data (type: string) ## Disclamer, misc