Skip to content

Commit 5b1fe8c

Browse files
authored
Merge pull request #10 from thetnaingtn/Update-README
Update README
2 parents 21cfb42 + bc2ac33 commit 5b1fe8c

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

README.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,28 @@
1-
# Forky
2-
**Forky** is a CLI application that you can use to sync your forks with upstream repositories within your terminal with simple and easy to understand UI. You can select single or multiple repositories at once and update all those repositories with ease.\
3-
The motivation behind **Forky** is to get rid of the burden of syncing one repository at a time. With **Forky**, you can syncing multiple repositories at same time, of course, with a elegance UI thanks to **[Charm's bubbletea](https://github.com/charmbracelet/bubbletea)** TUI framework.
4-
5-
## Usage
1+
# forky
2+
**forky** is a CLI tool that you can use to synchronize your forks with upstream repositories. You can select more than one repository at a time and synchronize them. To use **forky** you'll need to create a Github's personal access token.
3+
## Demo
4+
### Dark
5+
![forky-dark](./forky-dark.gif)
6+
### Light
7+
![forky-light](./forky-light.gif)
8+
## How does forky work basically?
9+
**forky** detect the `default` branch(`main`, `master`, or `trunk` whatever it is) of your forked repository and will try to compare it with the upstream repository's `same-named` branch to find how many commits behind by your forked repositories are. Then it will show available forks which left behind the upstream repositories to synchronize.
10+
## Installation
611
### Mac OS
712
```sh
813
brew install thetnaingtn/tap/forky
914
```
1015
then
1116
```sh
1217
forky --token `your github token`
18+
```
19+
## Keymaps
20+
You can use following keys to interact with **forky**
21+
| Key | Description |
22+
|:-----------------|:--------------------------------------------|
23+
| <kbd>a</kbd> | Select all forks |
24+
| <kbd>n</kbd> | Select none of the forks |
25+
| <kbd>space</kbd> | Toggle(select/unselect) the fork |
26+
| <kbd>r</kbd> | Refresh |
27+
| <kbd>m</kbd> | Merge the selected fork with upstream branch|
28+
| <kbd>q</kbd> | Quit |

forky-dark.gif

1.45 MB
Loading

forky-light.gif

738 KB
Loading

forky.gif

-252 KB
Binary file not shown.

0 commit comments

Comments
 (0)