Skip to content

Commit

Permalink
modified readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WaterHyacinthInNANHU committed Sep 10, 2021
1 parent 2bc5506 commit 28b36bf
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,38 @@ PaperHub is a command line tool to search papers using [dblp](https://dblp.org/)

## Installation

python=3.7+

```
pip install -r requirements.txt
```

### Usage
## Settings

```
There are few settings for you in `settings.json`

- `publishers`: a pre-defined list of publishers to specify when you choose ‘search by publishers’.

- `number_per_search`: number of papers to show for each search.

- `number_per_publisher`: max number of papers for each publisher.

- `style`: how to show searching result. Can be `default` or `rainbow`(colorful entries).

- `line_height`: line height in `px`.

- `rainbow_color`: color of components of entries in hex.

> You may find some pretty color scheme [here](http://brandcolors.net/).
## Usage

```
python dblpSearch.py
```

Then input keywords to search & choose whether to use pre-defined list of publisher.

## Demo

![image-20210910221059893](readme.assets/image-20210910221059893.png)

0 comments on commit 28b36bf

Please sign in to comment.