Skip to content

README: add formatting & increase MD compatibility #5

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: add formatting & increase MD compatibility #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Forkwork

[![image](https://img.shields.io/pypi/v/forkwork.svg)](https://pypi.org/project/forkwork/)
[![image](https://img.shields.io/pypi/l/forkwork.svg)](https://pypi.org/project/forkwork/)
[![image](https://img.shields.io/pypi/pyversions/forkwork.svg)](https://pypi.org/project/forkwork/)
Expand All @@ -9,20 +10,25 @@ Inspired by [forked](https://github.com/ys/forked)


## Requirements

* Python 3.5 and up

## Installation

from PyPI

```
$ pip install forkwork
```

from git repository

```
$ pip install git+https://github.com/github-tooling/forkwork
```

from source

```
$ git clone https://github.com/github-tooling/forkwork
$ cd forkwork
Expand All @@ -37,9 +43,11 @@ with the public_repo permission.

You can use token as environment variable ``FORKWORK_TOKEN`` at ``~/.bashrc`` or ``~/.zshrc``

```bash
export FORKWORK_TOKEN="****************************************"
```

or pass token as option --token
or pass token as option `--token`

```
$ forkwork --help
Expand All @@ -53,7 +61,9 @@ Commands:
fnm
top
```

top command option

```
$ forkwork https://github.com/mattdiamond/Recorderjs top --help

Expand All @@ -76,7 +86,9 @@ Options:
```

### Example usage

find top repo

```
$ forkwork https://github.com/mattdiamond/Recorderjs top -S --rows=5
+-----------------------------------------------+---------+---------+---------------+---------------+--------------+
Expand All @@ -95,6 +107,7 @@ $ forkwork https://github.com/mattdiamond/Recorderjs top -S --rows=5
```

find commit that don't merged and not pushed to a pull request

```
$ forkwork https://github.com/dimka665/vk fnm

Expand Down Expand Up @@ -122,14 +135,19 @@ a ?where={"_udpated": {"$gt": "<RFC1123 date>"}} request. https://github.com/wdt


## Development setup

Using [Poetry](https://poetry.eustace.io/docs/)

```
$ poetry install
```

or [Pipenv](https://docs.pipenv.org/)

```
$ pipenv install --dev -e .
```

## License

[MIT](https://choosealicense.com/licenses/mit/)