diff --git a/README.md b/README.md index e1e57f5..f72bc71 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,37 @@ -# Bank of Maldives CLI written in bash +# Bank of Maldives CLI +BML CLI written in Bash. This project is currently under development and a lot of things are broken. -## under dev, lots of things are broken. +## Requiments +`curl` `jq` -### can you pr ascii art lmao +### Ubuntu +`sudo apt install curl jq` -- Requiments -`curl` `jq` \ -Make sure you have both of them installed \ -`sudo apt install curl jq` on Ubuntu -### known bugs -- colored texts do not work in termux +### Fedora +`sudo dnf install curl jq` +### Arch +`sudo pacman -S curl jq` -### Use from source - Recommended +## Bugs +- Colored texts do not work in Termux +- Do **NOT** save passwords that contain one of the following characters +` | ^ $ & ; : ( )` + +## Installation + +### Recommended ``` -git clone https://github.com/shihaamabr/bmlcli +git clone https://github.com/shihaamabr/bml-cli -cd bmlcli/ +cd bml-cli chmod +x bml.sh ./bml.sh - ``` -### Installation - NOT Recommended (for now) -`curl -sL "https://raw.githubusercontent.com/shihaamabr/bmlcli/main/bml.sh" | sudo tee /usr/bin/bml-cli >/dev/null && sudo chmod 755 /usr/bin/bml-cli` -- Do NOT save password if password contain one of the following characters -` | ^ $ & ; : ( )` +### Not Recommended +``` +chmod +x install.sh +./install.sh +``` \ No newline at end of file diff --git a/install.sh b/install.sh new file mode 100644 index 0000000..46301d0 --- /dev/null +++ b/install.sh @@ -0,0 +1 @@ +curl -sL "https://raw.githubusercontent.com/shihaamabr/bml-cli/main/bml.sh" | sudo tee /usr/bin/bml-cli >/dev/null && sudo chmod 755 /usr/bin/bml-cli \ No newline at end of file diff --git a/pasrjsontest.sh b/parser_json_test.sh similarity index 100% rename from pasrjsontest.sh rename to parser_json_test.sh