Skip to content

Commit

Permalink
updated README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Gonzalo Salvador Corvalan committed Oct 13, 2021
1 parent 221ed06 commit 1df2a18
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
- [The Documentation](#the-documentation)
- [Dependencies](#packages-used-for-this-project)

<br/>
<br/>

# Getting Started
Expand All @@ -34,7 +33,6 @@ At last, I decided to use JWT as the authentication system for the API. Before u

Once all of that is done, you can fully start to work with this project.

<br/>
<br/>

# The Interface of a Credential
Expand Down Expand Up @@ -97,7 +95,7 @@ A credential may have 2 states, an encrypted state, and an decrypted state.
}
```

## The properties:
### The properties:

company_id, company, company_name are realetd to the associated company. Example:

Expand Down Expand Up @@ -137,7 +135,7 @@ You may have noticed that some inner properties, like "email" have an opening, e

<br/>

## The security codes
### The security codes

The decrypted unique_code will be a string, so the unique_code_lenght is the total characters of that string.

Expand All @@ -147,7 +145,6 @@ The other two codes are an array of strings. So their length represents the amou

And for the last of the Credential's properties, the security question and the security answer will be two separated strings. These two don't include a char_count for each one, beacuse just the length could be a hint of what they are.

<br/>
<br/>

## The properties of a Decrypted Credential
Expand Down Expand Up @@ -175,7 +172,6 @@ And for the last of the Credential's properties, the security question and the s
}
```

<br />
<br />

# The Authentication System
Expand Down Expand Up @@ -234,4 +230,4 @@ This project makes use of the following packages:

- **spatie/laravel-permission**: **^4.0** To manage roles and permissions.

- **tymon/jwt-auth**: **^1.0** To register users' sessiong on the API.
- **tymon/jwt-auth**: **^1.0** To register users' session on the API.

0 comments on commit 1df2a18

Please sign in to comment.