From 1b7e9d67b1a679d4fa2254253ec2c593dfafe0f3 Mon Sep 17 00:00:00 2001 From: Shihaam Abdul Rahman Date: Fri, 14 May 2021 04:27:13 +0500 Subject: [PATCH] Readme Clean up --- README.md | 37 ++++++++++++------------------------- 1 file changed, 12 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 904bf84..3621606 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,26 @@ # Bank of Maldives CLI -BML CLI written in Bash. This project is currently under development and a lot of things are broken. - +## BML CLI written in Bash. +This project is currently under development and a lot of things are broken. ![photo_2021-04-28_14-59-35](https://user-images.githubusercontent.com/18140039/116385581-5c948300-a832-11eb-899b-9133501a4ae7.jpg) - -## Requirements + +## Getting Started +### Requirements `curl` `jq` `openssl` -- Make sure all requirements are met before running script. +- Install with whatever package manager you use. +- Make SURE all requirements are met before running script. - Termux users will need `ncurses-utils` additionally for terminal colors -#### Arch Linux -`sudo pacman -S curl jq openssl` - -#### Ubuntu -`sudo apt install curl jq openssl` - -#### Fedora -`sudo dnf install curl jq openssl` - -### Termux -`pkg install curl jq openssl-tools ncurses-utils` - -### OpenSUSE -`sudo zypper install curl jq openssl` - -## Installation - git +#### Installation - GIT (Recommended) ``` git clone https://github.com/shihaamabr/bml-cli cd bml-cli chmod +x bml.sh ./bml.sh ``` -## Installation systemwide - BETA -`curl -sSL https://install.bml-cli.shihaam.dev | sudo bash` - - +#### Installation - Systemwide (NOT Recommended, May not work) +``` +curl -sSL https://install.bml-cli.shihaam.dev | sudo bash +``` ## Bugs - [You tell me :)](https://github.com/shihaamabr/bml-cli/issues/new)