Skip to content

Commit

Permalink
updated readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
laureanray committed Jun 29, 2022
1 parent 9a5c570 commit 5100b09
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,36 @@
# clibgen

clibgen is a command line tool for library genesis. (https://libgen.li/)
clibgen is a TUI for library genesis. (https://libgen.li, https://libgen.is)


### Install

# installation
Shell Installation (Mac, Linux)

```shell
curl -fsSL https://raw.githubusercontent.com/laureanray/clibgen/main/install.sh | sh
```

PowerShell Installation (Work in progress)

# contributing
### Usage

Search for a book using old the old website (default)
```shell
clibgen search "Eloquent JavaScript"
```

Search for a book using the newer website (useful if for some reason the old website is down or the mirrors are not working)
`-m or -mirror` flag
```shell
clibgen search -m "new" "Eloquent JavaScript"
```

Limit search results
```shell
clibgen search -n 5 "Eloquent JavaScript"
```


### Found an issue?
Please open up an issue or a PR if you have a fix for it ;)

0 comments on commit 5100b09

Please sign in to comment.