README.md
November 29, 2023 ยท View on GitHub
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
- bare-minimum โ General purpose template
- tiny-web โ Web app template
โญ hit the star button if you found this useful โญ
Source | Blog | Twitter | LinkedIn | More Links | Other Projects