caesar-encrypt - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "caesar-encrypt",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "One of the simplest forms of encryption",
@@ -19,2 +19,10 @@ "main": "index.js",
   },
+  "keywords": [
+    "caesar",
+    "encrypt",
+    "encryption",
+    "caesar-encrypt",
+    "cipher",
+    "caesar-cipher"
+  ],
   "xo": {
@@ -21,0 +29,0 @@ "space": true,

README.md

@@ -1,7 +0,4 @@
-# caesar-encrypt
+# caesar-encrypt [![Build Status](https://travis-ci.org/bukinoshita/caesar.svg?branch=master)](https://travis-ci.org/bukinoshita/caesar)
 > One of the simplest forms of encryption
 
-[![Codeship Status for bukinoshita/caesar](https://app.codeship.com/projects/0165eea0-dc14-0134-a8b9-721cd3f7afb3/status?br nch=master)](https://app.codeship.com/projects/204204)
-[![GitHub release](https://img.shields.io/github/release/bukinoshita/caesar.svg)](https://www.npmjs.com/package/caesar)
-[![license](https://img.shields.io/github/license/bukinoshita/caesar.svg)](https://raw.githubusercontent.com/bukinoshita/caesar/master/LICENSE)
 
@@ -13,2 +10,3 @@ ## Install
 
+
 ## Usage
@@ -25,13 +23,14 @@ ```js
 
+
 ## API
-### caesar-encrypt
+### caesarEncrypt
 
-### encrypt(input, shift)
+### .encrypt(input, shift)
 
 #### input
-Type: string<br/>
+Type: `string`<br/>
 Required
 
 #### shift
-Type: number<br/>
+Type: `number`<br/>
 Required
@@ -41,9 +40,24 @@
 
+
+### .decrypt(input, shift)
+
+#### input
+Type: `string`<br/>
+Required
+
+#### shift
+Type: `number`<br/>
+Required
+
+shift should be a number between 1-26
+
 ## Understand Caesar Cipher
 > The Caesar cipher, also known as a shift cipher, is one of the simplest forms of encryption. It is a substitution cipher where each letter in the original message (called the plaintext) is replaced with a letter corresponding to a certain number of letters up or down in the alphabet. [Learn more](https://learncryptography.com/classical-encryption/caesar-cipher)
 
+
 ## Related
 - [save-me](https://github.com/bukinoshita/save-me) — :lock: Save anything
 
+
 ## License
-[MIT](https://github.com/bukinoshita/caesar/blob/master/LICENSE) &copy; Bu Kinoshita
+MIT © [Bu Kinoshita](https://bukinoshita.io)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

11

increased by10%

Number of lines in readme file

61

increased by29.79%

Worsened metrics

Total package byte prevSize

5238

decreased by-0.85%

No dependency changes