V0.4

.gitignore

@@ -1,3 +1,6 @@
 *__pychache__
 credentials
 *pyc
+.env
+.*.swp
+tmp/

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+> here you can see every change between versions
+
+## v0.4
+### Fixed
+ - python3.4 had problems with singal.signal()
+ - manage project if there is no arguments
+
+## v0.3
+### Added
+ - Handle Ctrl-c in checker
+ - `makefile` with `install` and `uninstall`
+ - `EOL` with a goodbye message
+
+## v0.2
+### Added
+ - `.env` file support, It use `EMAIL`, `PASSWORD`, `API`, `DEBUG` variables
+ - `VERSION`, `PATH_CRED` variables
+
+### Fix
+ - Set installation confirmation problem with ['Y'/'N']
+ - checker.py with pycodestyle
+ - move `hbnb_creds`, the `/tmp` folder delete the credentials
+
+

README.md

@@ -1,7 +1,107 @@
-# ⚡ CLI_Checker ⚡
-A Holberton School checker tool to avoid using your browser to check manaully every task of your current project.
+# ⚡ CLI_Checker (vTavo) ⚡
+ > A Holberton School checker tool to avoid using your browser to check manaully every task of your current project.<br>
+ > This is a fork of the original project by Diego Lopez. Please check his [page][CLI_Diego]
 
+## Prerquisites
+You need the [tools][api_link] section available in the intranet. You can check
+if you have this icon in the left menu:
+
+<div style="text-align:center">
+<img align"center" src="/assets/tool_icon2.png"/>
+</div>
+
+## How to install
+
+Run the instalation script
+```console
+$ bash <(curl -sL https://github.com/Athesto/CLI_Checker/raw/main/install.sh)
+$ checker
+```
+the program are going to ask for:
+ - your holberton's __email__ (xxxx@holbertonshcool.com)
+ - your __API__ key ([link][api_link])
+   - it's in the __Intranet > Tools > Holberton's Intranet API key__
+   - it's an HEX string of 32 chars ex. `123abc123abcdef99001122cdef12351`
+ - your intranet's __password__ (it will be hidden so don't worry if you don't see the chars)
+
+## How to use
+just run cecker in your terminal ant the checker terminal will start
+
+```console
+$ checker
+CLI-Checker ⚡
+```
+Now that you are in the console, you has to select the project with `project <num>`.
+The project's number is the last number of the url<br>
+
+#### Example of use
+Suppose that you want to check the project __0x00. C - Hello, World__<br>
+The url is `https://intranet.hbtn.io/projects/212`<br>
+So, the project's number is __212__
+```console
+CLI-@Checker ⚡$ project 212
+0 - Preprocessor
+1 - Compiler
+2 - Assembler
+3 - Name
+4 - Hello, puts
+5 - Hello, printf
+6 - Size is not grandeur, and territory does not make a nation
+7 - What happens when you type gcc main.c
+8 - Intel
+9 - UNIX is basically a simple operating system, but you have to be a genius to understand the simplicity
+
+  ┌─ You may now run:
+  │
+  └─┬─ check <task number>
+    ├ To check a specific task.
+    │
+    ├─ check Not implemented yet🤕, Sorry.
+    ├ To check all tasks of current project.
+    └─┐
+      ├─ To check only task 2 you would run
+      │
+      └─ Example: check 2
+
+CLI-@Checker ⚡$ check 1
+Task 1 Compiler
+Checking your code... 🎉
+🔥 Check 0: Approved 🏆
+⚡ Check 1: Approved 🔥
+🤩 Check 2: Approved 🎊
+🥂 Check 3: Approved 🔥
+```
+
+### Available commands
+ - help: show help. `available` is misspelled
+ - EOF: (Ctrl-D) finish the console
+ - quit: finish the console (same as EOF)
+ - project: select project
+ - check: slect task
+
+### How to uninstall
+To uninstall you only need to delete these files
+ - `/opt/checker`
+ - `/usr/local/bin/checker`
+ - credentials in `~/.config/hbn`
+```console
+$ sudo rm -rf /opt/checker/
+$ sudo rm /usr/local/bin/checker
+$ rm -rf ~/.config/hbn
+```
 ## Contributors
-- Diego Lopez
-- Wiston Venera 
-- Leonardo Valencia
+- [Diego Lopez][@DiegoCol93]
+- [Wiston Venera][@wsvem]
+- [Leonardo Valencia][@4ions]
+- [Gustavo Mejía][@Athesto]
+
+<!--links-->
+[api_link]: https://intranet.hbtn.io/dashboards/my_tools
+[@Athesto]: https://github.com/Athesto
+[@wsvem]: https://github.com/wisvem
+[@4ions]: https://github.com/4ions
+[@DiegoCol93]: https://github.com/DiegoCol93
+[CLI_Diego]: https://github.com/DiegoCol93/CLI_Checker/
+[tool_icon2]: https://github.com/Athesto/CLI_Checker/raw/main/assets/tool_icon2.png
+[tool_icon3]: /assets/tool_icon2.png
+