tmux2k/README.md
Abhishek Keshri f5b5fce23f
Update Readme
2022-08-09 04:41:43 +05:30

108 lines
2.7 KiB
Markdown

<div align = "center">
<h1><a href="https://2kabhishek.github.io/tmux2k">tmux2k</a></h1>
<a href="https://github.com/2KAbhishek/tmux2k/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/2kabhishek/tmux2k?style=flat&color=eee&label="> </a>
<a href="https://github.com/2KAbhishek/tmux2k/graphs/contributors">
<img alt="People" src="https://img.shields.io/github/contributors/2kabhishek/tmux2k?style=flat&color=ffaaf2&label=People"> </a>
<a href="https://github.com/2KAbhishek/tmux2k/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/2kabhishek/tmux2k?style=flat&color=98c379&label=Stars"></a>
<a href="https://github.com/2KAbhishek/tmux2k/network/members">
<img alt="Forks" src="https://img.shields.io/github/forks/2kabhishek/tmux2k?style=flat&color=66a8e0&label=Forks"> </a>
<a href="https://github.com/2KAbhishek/tmux2k/watchers">
<img alt="Watches" src="https://img.shields.io/github/watchers/2kabhishek/tmux2k?style=flat&color=f5d08b&label=Watches"> </a>
<a href="https://github.com/2KAbhishek/tmux2k/pulse">
<img alt="Last Updated" src="https://img.shields.io/github/last-commit/2kabhishek/tmux2k?style=flat&color=e06c75&label="> </a>
<h3>Short sweet headline with 🎇🎉</h3>
<figure>
<img src= "images/screenshot.png" alt="tmux2k Demo">
<br/>
<figcaption>tmux2k screenshot</figcaption>
</figure>
</div>
## What is this
tmux2k is a `<utility/tool/feature>` that allows `<insert_target_audience>` to do `<action/task_it_does>`.
## Inspiration
tmux2k was inspired by `<reason/idea>`.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of `<coding_language/dependency/requirement_1>`
## Getting tmux2k
To get tmux2k, follow these steps:
```bash
git clone https://github.com/2kabhishek/tmux2k
cd tmux2k
<install_command>
```
## Using tmux2k
```bash
USAGE:
command [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information.
OPTIONS:
-o, --option <value> Option description.
Options are: a, b. [default: a]
Example:
```
## How it was built
tmux2k was built using `<tech/library>`
## Challenges faced
While building tmux2k the main challenges were `<issue/difficulty>`
## What I learned
While building tmux2k I `<learned/accomplished>` about `<learning/accomplishment>`
## What's next
Planning to add `<feature/module>`.
### To-Do
- [x] Setup repo
- [ ] Think real hard
- [ ] Start typing
- [ ] Change me
- [ ] Update README
- [ ] Finish it
Hit the ⭐ button if you found this useful.
## More Info
<div align="center">
<a href="https://github.com/2KAbhishek/tmux2k">Source</a> | <a href="https://2kabhishek.github.io/tmux2k">Website</a>
</div>