Update readme.md

README.md

@@ -1,190 +1,350 @@
-<p align="center">
-  <img src="logo-slogan.png" width="256"/>
+
+<p  align="center">
+
+<img  src="logo-slogan.png"  width="256"/>
+
 </p>
 
+
+
 # X development tools
+
 [![](https://dcbadge.vercel.app/api/server/HwBWUSRUew)](https://discord.com/invite/HwBWUSRUew)
+
 [![codecov](https://codecov.io/gh/ahelmy/xdev/graph/badge.svg?token=INCX6KXGD7)](https://codecov.io/gh/ahelmy/xdev)
+
 
 
 ## Inspired by [DevToys](https://github.com/veler/DevToys)
 
+
+
 XDev helps with daily development tasks like formatting JSON, base64 encoding / decoding and others. No need to use many untrustworthy websites to do simple tasks with your data.
 
 
 
+
+
 ## Table of Contents
 
 
 
+
+
 - [Installation](#installation)
 
+
+
 - [Development](#development)
 
+
+
 - [Usage](#usage)
 
+- [Architecture](#architecture)
+
 - [Docker](#docker)
 
+
+
 - [Web UI](#web-ui)
 
+
+
 - [Features](#features)
 
+
+
 - [Contributing](#contributing)
 
+
+
 - [License](#license)
 
 
 
+
+
 ## Installation
 
 
 
+
+
 1. Clone the repository:
 
+
+
 ```shell
 
-git clone https://github.com/ahelmy/xdev.git
+
+
+git  clone  https://github.com/ahelmy/xdev.git
+
+
 
 ```
 
 
 
+
+
 2. Navigate to the project directory:
 
+
+
 ```shell
 
-cd xdev
+
+
+cd  xdev
+
+
 
 ```
 
 
 
+
+
 3. Build from source:
 
+
+
 ```shell
 
-go build -o xdev
+
+
+go  build  -o  xdev
+
+
 
 ```
 
 
 
+
+
 4. Start the application:
 
+
+
 ```shell
 
+
+
 ./xdev
 
+
+
 ```
 
+
+
 ## Development
 
+
+
 Requirements:
+
 - go >= 1.20
 
+
+
 ## Usage
 
-You can use it directly by:  
+
+
+You can use it directly by:
+
 ```shell
+
 go  install  github.com/ahelmy/xdev@latest
+
 ```
 
+
+
 if `go/bin` is not in your path, either add it or use `~/go/bin`
+
 ```shell
-xdev -h
+
+xdev  -h
+
 ```
 
+
+
 ```shell
-Developer Swiss Army Knife tools X for anything.
+
+Developer  Swiss  Army  Knife  tools  X  for  anything.
+
+
 
 Usage:
-  xdev [flags]
-  xdev [command]
-
-Available Commands:
-  base64decoder   Decode base64 string. Alias: b64d
-  base64encoder   Encode string to base64. Alias: b64e
-  completion      Generate the autocompletion script for the specified shell
-  hash            Hash a string
-  help            Help about any command
-  json            JSON indentation and minification
-  json2yaml       Convert JSON to YAML. Alias: j2y
-  jwt             Decode or encode a JWT string.
-  password        Password generator. Alias: pwd
-  properties2yaml Convert Java Properties to YAML, Alias: p2y
-  server          Start a web server, Alias: s
-  time            Time command to covert and manupulate time
-  ulid            Generate a ulid string
-  url             URL encode/decode.
-  uuid            Generate a uuid string
-  yaml2json       Convert YAML to JSON. Alias: y2j
-  yaml2properties Convert YAML to Java Properties, Alias: y2p
+
+xdev [flags]
+
+xdev [command]
+
+
+
+Available  Commands:
+
+base64decoder  Decode  base64  string.  Alias:  b64d
+
+base64encoder  Encode  string  to  base64.  Alias:  b64e
+
+completion  Generate  the  autocompletion  script  for  the  specified  shell
+
+hash  Hash  a  string
+
+help  Help  about  any  command
+
+json  JSON  indentation  and  minification
+
+json2yaml  Convert  JSON  to  YAML.  Alias:  j2y
+
+jwt  Decode  or  encode  a  JWT  string.
+
+password  Password  generator.  Alias:  pwd
+
+properties2yaml  Convert  Java  Properties  to  YAML,  Alias:  p2y
+
+server  Start  a  web  server,  Alias:  s
+
+time Time command to covert and manupulate time
+
+ulid  Generate  a  ulid  string
+
+url  URL  encode/decode.
+
+uuid  Generate  a  uuid  string
+
+yaml2json  Convert  YAML  to  JSON.  Alias:  y2j
+
+yaml2properties  Convert  YAML  to  Java  Properties,  Alias:  y2p
+
+
 
 Flags:
-  -h, --help      help for xdev
-  -v, --version   Print the version number
 
-Use "xdev [command] --help" for more information about a command.
+-h,  --help  help  for  xdev
+
+-v,  --version  Print  the  version  number
+
+
+
+Use  "xdev [command] --help"  for  more  information  about  a  command.
+
 ```
+
+## Architecture
+
+The project devided into layers, the core (internal) which contains all logic and outside layers of different consumers (command line, APIs, webUI, terminal).
+<p  align="center">
+  <img  src="assets/Arch.png" />
+</p>
+
+
 ## Docker
 
 If you want to use `Xdev` as server running in docker container you can use https://hub.docker.com/r/ahelmy0/xdev
+
 
 `Environment`
-- `PORT` Server port, default: 8000
-- `VERBOSE` To enable verbose mode.
+
+-  `PORT` Server port, default: 8000
+
+-  `VERBOSE` To enable verbose mode.
+
+
 
 ## Web UI
 
-<img src="screenshots/home.png" width="25%"/><img src="screenshots/uuid.png" width="25%"/><img src="screenshots/ulid.png" width="25%"/><img src="screenshots/json.png" width="25%"/><img src="screenshots/jwt.png" width="25%"/><img src="screenshots/password.png" width="25%"/><img src="screenshots/yaml.png" width="25%"/><img src="screenshots/base64.png" width="25%"/>
+
+
+<img  src="screenshots/home.png"  width="25%"/><img  src="screenshots/uuid.png"  width="25%"/><img  src="screenshots/ulid.png"  width="25%"/><img  src="screenshots/json.png"  width="25%"/><img  src="screenshots/jwt.png"  width="25%"/><img  src="screenshots/password.png"  width="25%"/><img  src="screenshots/yaml.png"  width="25%"/><img  src="screenshots/base64.png"  width="25%"/>
+
+
 
 ## Features
 
+
+
 List of features:
 
+
+
 - [X] UUID, ULID Generator
 
+
+
 - [X] JWT encoding / decoding
 
+
+
 - [X] Base64 encoding / decoding
 
+
+
 - [X] JSON indention / minifying
 
-- [X] Password generator  
+
+
+- [X] Password generator
+
+
 
 - [X] JSON to Yaml
 
+
+
 - [X] Yaml to JSON
 
+
+
 - [X] URL encoding / decoding
 
+
+
 - [X] Add hashing (SHA256, MD5, ...)
 
+
+
 - [X] Time conversion
 
+
+
 - [X] Yaml2Properties
 
+
+
 **Next**
 
-- [ ] Add `choco`, `brew` and `linux` package managers download.
+- [ ] Text differences.
 
-...
+- [ ] Add `choco`, `brew` and `linux` package managers download.  
 
+...
 
 
 ## Contributing
 
 
 If you are interested to fix an issue or to add new feature, you can just open a pull request.
+
 
 ### Contributors
-<a href = "https://github.com/ahelmy/xdev/graphs/contributors">
-  <img src = "https://contrib.rocks/image?repo=ahelmy/xdev"/>
-</a>
 
+<a  href = "https://github.com/ahelmy/xdev/graphs/contributors">
 
-## License
+<img  src = "https://contrib.rocks/image?repo=ahelmy/xdev"/>
+
+</a>
 
 
 
-Licensed with Apache 2.0
+## License
+
+Licensed with Apache 2.0