aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3ca5b74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+<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
+
+```
+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).