paper-auth 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed11e6dc83d42929f6038911106027593b61228f
-  data.tar.gz: 4ec439661e864c17736cf8ae622bf02a0d62c7be
+  metadata.gz: f42475d9bf632254522849def8e4ce785f66aa8d
+  data.tar.gz: e9a7daafd5c3f44c3beda0e11806e951240e47ab
 SHA512:
-  metadata.gz: f14252c03a5a7713190dbb02f95da44bfd7a96bb43b91792e16f2d2332fc4568e530f5c94b76756c522f5fc523b6197eaed7193488c5c9c28e37b1497800a957
-  data.tar.gz: 9ffb856493917ceb4636dc03d13980bc0a1a3bfd631c886153a2440434c33fd376719564b0ea93ac2fa4bdcbc2542ee5deea420f296673be3ecc157a8349f016
+  metadata.gz: 99304f54c3f9cd3893d133b438949ab4585e10a4121ef80c370b3ec433a450c8c001a1cf7d385e003030292296a92cd263f884b096eb482fc9b603b5a5e9f2f5
+  data.tar.gz: 463c396168c3fbd7095a2a1f36068976b51310e56965cd818ed8bb9b876b179cdc18abc0a1bb2c03a9449a0d9373924a6cd24fbf0c1a056d3f6e84eab89315a3

data/README.md

@@ -1,6 +1,6 @@
-# Paper::Auth
+# Paper-Auth
 
-TODO: Write a gem description
+Paper-Auth is a paper based two factor authenctication.
 
 ## Installation
 
@@ -20,11 +20,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initialize
+
+Create a new instance of PaperAuth.
+
+```
+paper = PaperAuth.new()
+```
+
+Currently you do not need to provide any parameters.
+
+### Create a PDF
+
+Create a pdf using PaperAuth.
+
+```
+pdf = paper.create(0, "Hello World!")
+```
+
+The first parameter should be something specific to the user (Ex. User ID), and the second parameter should be a secret key that ONLY you know. When called, a pdf will be generated and saved in the current path that you are located in.
+
+### Get an ID
+
+You can easily request for an ID using PaperAuth.
+
+```
+id = paper.get()
+```
+
+Currently you do not need to provide any parameters. This will just generate a random ID (Ex. 1A, 10E, etc.) that you can request from the user.
+
+### Verifying a Code
+
+You can easily verify a two factor authentication code.
+
+```
+verify = paper.verify(0, "Hello World!", "1A", "1A2B3")
+```
+
+The first two parameters must be the exact same paramenters you used to generate the pdf. The third parameter is the ID that you generated from `paper.get()`, and the fourth parameter is what the user typed. This method will return true or false.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/paper-auth/fork )
+1. Fork it ( https://github.com/nahtnam/paper-auth/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/paper-auth/version.rb

@@ -1,3 +1,3 @@
 class PaperAuth
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper-auth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Manthan Mallikarjun