rename to string-crypto

README.md

@@ -1,4 +1,4 @@
-# String Crypt
+# String Crypto
 
 Small and and simple (yet secure) library to encrypt and decrypt strings using PBKDF2 for key derivation and AES (defaulted to 256-bit / SHA512).
 
@@ -8,16 +8,16 @@ Please consider:
 
 - [Buying me a coffee](https://www.buymeacoffee.com/jeanlescure) :coffee:
 - Supporting me on [Patreon](https://www.patreon.com/jeanlescure) :trophy:
-- Starring this repo on [Github](https://github.com/jeanlescure/string-crypt) :star2: :octocat:
+- Starring this repo on [Github](https://github.com/jeanlescure/string-crypto) :star2: :octocat:
 
 ## Usage
 
 ```
-yarn add string-crypt
+yarn add string-crypto
 ```
 
 ```ts
-import StringCrypt from 'string-crypt';
+import StringCrypto from 'string-crypto';
 
 const stringToProtect = 'What is the largest (rational) number n such that there are positive integers p, q, r such that 1 - 1/p - 1/q - 1/r = 1/n?';
 
@@ -26,7 +26,7 @@ const password = 'Oh-no,not-again';
 const {
   encryptString,
   decryptString,
-} = new StringCrypt();
+} = new StringCrypto();
 
 let encryptedString = encryptString(topSecret, password);
 
@@ -48,7 +48,7 @@ const options = {
 const {
   encryptString: saferEncrypt,
   decryptString: saferDecrypt,
-} = new StringCrypt(options);
+} = new StringCrypto(options);
 ```
 
 ## Development and build scripts

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "string-crypt",
+  "name": "string-crypto",
   "version": "1.0.0",
   "description": "Small and and simple (yet secure) library to encrypt and decrypt strings using PBKDF2 for key derivation and AES (defaulted to 256-bit / SHA512)",
   "main": "dist/index.js",
@@ -9,7 +9,7 @@
   "scripts": {
     "build": "rollup -c",
     "dev": "concurrently \"rollup -cw\" \"nodemon --inspect runkit.js\"",
-    "postinstall": "yarn link && yarn link string-crypt"
+    "postinstall": "yarn link && yarn link string-crypto"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^15.0.0",

runkit.js

@@ -1,4 +1,4 @@
-var StringCrypt = require('string-crypt');
+var StringCrypto = require('string-crypto');
 
 const topSecret = 'What is the largest (rational) number n such that there are positive integers p, q, r such that 1 - 1/p - 1/q - 1/r = 1/n?';
 
@@ -7,7 +7,7 @@ const password = 'Oh-no,not-again';
 const {
   encryptString,
   decryptString,
-} = new StringCrypt();
+} = new StringCrypto();
 
 let encryptedString = encryptString(topSecret, password);
 
@@ -18,7 +18,7 @@ console.log('Decrypted String:', decryptString(encryptedString, password));
 const {
   encryptString: saferEncrypt,
   decryptString: saferDecrypt,
-} = new StringCrypt({
+} = new StringCrypto({
   salt: '2f0ijf2039j23r09j2fg45o9ng98um4o',
   iterations: 10,
 });

src/index.ts

@@ -56,7 +56,7 @@ const deriveKey = (
   return pbkdf2Sync(password, salt, iterations, keylen, digest);
 };
 
-class StringCrypt {
+class StringCrypto {
   private _deriveKeyOptions: DeriveKeyOpts;
 
   constructor(options?: DeriveKeyOpts) {
@@ -118,4 +118,4 @@ class StringCrypt {
   };
 }
 
-export default StringCrypt;
+export default StringCrypto;