Skip to content

Commit

Permalink
Merge pull request #15 from jenish-jain/doc
Browse files Browse the repository at this point in the history
enhancing main readme
  • Loading branch information
jenish-jain authored Nov 5, 2023
2 parents 980b012 + 76813bc commit ba32e78
Showing 1 changed file with 7 additions and 10 deletions.
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

0 comments on commit ba32e78

Please sign in to comment.