README.md

November 29, 2023 ยท View on GitHub

shelly

License People Stars Forks Watches Last Updated

Publish CLI Tools ๐Ÿšโœจ

shelly in action
shelly in action

shelly is a <utility/tool> that allows <target_audience> to <action>.

โœจ Features

  • Comes with a ready to go shell template
  • Quick documentation with README template
  • Works with mkrepo

โšก Setup

โš™๏ธ Requirements

  • foo >= bar
  • bazz

๐Ÿ’ป Installation

git clone https://github.com/2kabhishek/shelly
cd shelly
# Link mkrepo to a directory that's in PATH (~/.local/bin here)
ln -sfnv "$PWD/shelly.sh" ~/.local/bin/shelly

๐Ÿš€ Usage

USAGE:

shelly <REQUIRED> [OPTIONAL]

Arguments:
    REQUIRED: Required Argument
    OPTIONAL: Optional Argument

Example:
    shelly

๐Ÿ—๏ธ What's Next

Planning to add <feature/module>.

โœ… To-Do

  • Setup repo
  • Think real hard
  • Start typing

๐Ÿง‘โ€๐Ÿ’ป Behind The Code

๐ŸŒˆ Inspiration

shelly was inspired by <reason/idea>.

๐Ÿ’ก Challenges/Learnings

  • The main challenges were <issue/difficulty>
  • I learned about <learning/accomplishment>

๐Ÿงฐ Tooling

  • dots2k โ€” Dev Environment
  • nvim2k โ€” Personalized Editor
  • sway2k โ€” Desktop Environment
  • qute2k โ€” Personalized Browser

๐Ÿ” More Info


โญ hit the star button if you found this useful โญ

Source | Blog | Twitter | LinkedIn | More Links | Other Projects