Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhancing main readme #15

Merged
merged 1 commit into from
Nov 5, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sprinkle in a bit of entertainment whenever you fancy.
You've got yourself a dynamic duo, honey! 💁‍♀️️💥

### how to run it locally
get random dad joke

````shell
go run main.go dadjoke
go run main.go <command>
````


Expand All @@ -19,14 +19,11 @@ brew install jenish-jain/tap/sidekick

### what can your sidekick do?

* Tell you a dad joke. 😉
```shell
sidekick dadjoke
```
* manage your 2FAs 💁‍ > [doc](internal/twoFA/Readme.md)
```shell
sidekick 2fa --list
```
| Command | Description | Docs |
|:-----------:|:------------------------|:-------------------------------:|
| **dadjoke** | Tell you a dad joke. 😉 | `sidekick dadjoke` |
| **2fa** | manage your 2FAs 💁‍ | [doc](internal/twoFA/Readme.md) |


### see the tool in action
![sidekick-demo](assets/sidekick-demo.gif)
Expand Down