diff --git a/readme.md b/readme.md index 0a6d4eb..d9b8f4d 100644 --- a/readme.md +++ b/readme.md @@ -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) \ No newline at end of file