Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
8hantanu authored Apr 27, 2024
1 parent e006666 commit a95a395
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,35 @@
# plug
# plug ๐Ÿ”Œ

**unleash efficiency!**
**Unleash efficiency!**

plug is a collection of simple bash scripts to accelerate day-to-day tasks or
cli-based workflows
A collection of simple bash scripts to accelerate day-to-day tasks or CLI-based workflows.

## getting started
## Steps ๐Ÿ—๏ธ

to get started with plug, follow these simple steps:
To get started with Plug, follow these simple steps:

1. clone the plug repository:
1. Clone the Plug repository:
```bash
git clone https://github.com/8hantanu/plug.git
```
2. set environment variable `PLUG_PATH` to the plug dir and add to path
2. Set environment variable `PLUG_PATH` to the Plug directory and add to path:
```bash
export PLUG_PATH=<path/to/plug>
export PATH="$PLUG_PATH:$PATH"
```
3. ???
4. profit
4. Profit!

## package includes
## Includes ๐Ÿ“ฆ

* `cmdr` - manage, search and execute your commands
* `hexd` - convert hexadecimal to decimal and back
* `knot` - notify task completion for sequential multi-tasking
* ๐Ÿšจ `cmdr` - Manage, search, and execute your commands
* ๐Ÿ”ฎ `hexd` - Convert hexadecimal to decimal and back
* ๐Ÿงต `knot` - Notify task completion for sequential multitasking

## feedback
## Feedback ๐Ÿ“

any ideas, suggestions, or feedback regarding plug, please feel free to open an
issue on the repository
Any ideas, suggestions, or feedback regarding plug, please feel free to open an issue on the repository.

## license

plug is open-source software licensed under the [mit
license](https://opensource.org/licenses/mit)
## License ๐Ÿ“œ

plug is open-source software licensed under the [MIT License](https://opensource.org/licenses/MIT).

0 comments on commit a95a395

Please sign in to comment.