blob: 212015ec112eb6da59311a003721b0fe21c15d70 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<h1 align="center">🍯 Nectar</h1>
<p align="center">
<b>Command-line <a href="https://www.honeyfeed.fm/">Honeyfeed</a> Reader</b>
</p>
## Installation
### *Building* From Source
[Bashly](https://bashly.dannyb.co/) is required to *build* Nectar.
```shell
git clone https://github.com/Fuwn/nectar.git
cd nectar
bashly generate
./nectar
```
To make Nectar globally accessible, add Nectar to your `PATH` environment variable.
### Pre-*built* Archives
Complete Nectar *builds* can be located in the *[Releases](https://github.com/Fuwn/nectar/releases)* tab.
## Usage
### Dependencies
- [Gum](https://github.com/charmbracelet/gum/)
- [pup](https://github.com/ericchiang/pup)
- [Pandoc](https://pandoc.org/)
- [Glow](https://github.com/charmbracelet/glow)
### Help
```
nectar - Command-line Honeyfeed Reader
Usage:
nectar COMMAND
nectar [COMMAND] --help | -h
nectar --version | -v
Commands:
chapter Read a chapter directly in your terminal
novel Select a chapter to read directly in your terminal
search Search and select a novel to read directly in your terminal
Options:
--help, -h
Show this help
--version, -v
Show version number
```
## License
This project is licensed with the [GNU General Public License v3.0](./LICENSE).
|