[fix] Indenting

documentation/README.rst

@@ -1,75 +1,75 @@
-=============
+================
 Documentation
-=============
+================
 
 .. contents::
 
-Functional requirements
+Requirements
---------------------------
+----------------------------------
-
+Funtional:
-- A user name and password auth
+    - A user name and password auth
-- Encrypted sensitive data
+    - Encrypted sensitive data
-- The employee need to have their full name captured
+    - The employee need to have their full name captured
-    - The last name must tolerate being null
+        - The last name must tolerate being null
-- An email will be needed for the employee
+    - An email will be needed for the employee
-    - The email format must be formated
+        - The email format must be formated
-- Employees will need a phone number
+    - Employees will need a phone number
-- Searching employees despite the encryption
+    - Searching employees despite the encryption
-- Employees must have a unique code to reference them 
+    - Employees must have a unique code to reference them 
-- Being able to modify the name, email and phone values of already existing employees
+    - Being able to modify the name, email and phone values of already existing employees
-- Having the values for the different payments parametrized
+    - Having the values for the different payments parametrized
-- Allowing for employees to perform other roles during their work day
+    - Allowing for employees to perform other roles during their work day
-      - Only for the auxiliary personnel
+          - Only for the auxiliary personnel
-- Taking into account only the current month for the salary
+    - Taking into account only the current month for the salary
-- Reducing the taxes for the salary
+    - Reducing the taxes for the salary
-      - If it goes beyond the threshold a different percentage is paid in taxes
+          - If it goes beyond the threshold a different percentage is paid in taxes
-      - The way the extra tax is handled should be parametrized
+          - The way the extra tax is handled should be parametrized
   
- Non functional requirements
- ---------------------------
- - Session management
-- Data integrity
-- Data security
-- Accessible through web
-- Containerized
 
-In
+Funtional: 
------
+    - Session management
-- Employee details
+    - Data integrity
-    - First name
+    - Data security
-    - Middle name
+    - Accessible through web
-    - Last name
+    - Containerized
-    - Birth date
-    - Email
-    - Phone number
-- Work per day
-    - Number of deliveries
-    - Rol performed
 
-Process
+Software behaivor
------------
+-----------------
-- Register a new employee
+In:
-- Modify employee
+    - Employee details
-- Search employee
+        - First name
-- Add new work day for employee
+        - Middle name
-- Calculate monthly payment for employee
+        - Last name
+        - Birth date
+        - Email
+        - Phone number
+    - Work per day
+        - Number of deliveries
+        - Rol performed
+Process:
+    - Register a new employee
+    - Modify employee
+    - Search employee
+    - Add new work day for employee
+    - Calculate monthly payment for employee
 
-Out
+Out:
------
+    - Upon registering
-- Upon registering
+        - Employee code
-    - Employee code
+    - In the work days registry
-- In the work days registry
+        - Raw salary for the the month
-    - Raw salary for the the month
+        - Taxes discounted
-    - Taxes discounted
+        - Real salary for the month
-    - Real salary for the month
+        - Vouchers (if applicable)
-    - Vouchers (if applicable)
  
 Tests
--------
+-----------------
-here go the tests
+Tests:
+- here go the tests
 
-Tools and software used
+Tools
-------
+----------------------------------
+The following tools and software were used:
 - phpstorm
 - git
 - docker && docker-compose