diff --git a/Cargo.toml b/Cargo.toml index 137a230..7c51421 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,10 +1,17 @@ [package] name = "lares" version = "0.1.0" -authors = ["Zeyi Fan "] +authors = ["Zeyi Fan "] edition = "2018" +description = "Simple RSS Reader Service (Fever API backend)" +license = "MIT" +homepage = "https://github.com/fanzeyi/lares" +readme = "README.md" +keywords = ["rss", "rssreader", "fever"] +categories = [] # :( -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +[badges] +maintenance = { status = "actively-developed" } [dependencies] rusqlite = { version = "0.23", features = ["array", "bundled", "chrono"] } @@ -23,3 +30,4 @@ rss = "1.9.0" prettytable-rs = "0.8.0" futures = "0.3.5" chrono = { version = "0.4.13" } + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3580a9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Zeyi Fan + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e41c3d9 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Lares: Minimal Fever API Implementation + +[![Build Status](https://github.com/fanzeyi/lares/workflows/.github/workflows/buildtest.yml/badge.svg)](https://github.com/fanzeyi/lares/actions?query=workflow%3A%22Build+%26+Test%22) [![Crates.io](https://img.shields.io/crates/v/lares)](https://crates.io/crates/lares) + +**Lares** is a minimal [Fever API](https://feedafever.com/api) implementation +written in Rust. It aims to provide a RSS reader backend with zero setup. It +uses SQLite 3 as storage engine. **It does not provide an user interface.** + +It is recommended to use Reeder as client to lares. + +## Install + +``` +cargo install lares +``` + +_Binary package will be provided in the future._ + +## Usage + +Lares consists of two parts, CLI and server. Feeds and groups are only +manageable via the command line interface. + +``` +$ lares --help +lares 0.1.0 +Minimal RSS service + +USAGE: + lares + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +SUBCOMMANDS: + feed Manages feeds + group Manages group + help Prints this message or the help of the given subcommand(s) + server Starts web server +``` + +Or, to start a server: + +``` +$ lares server -H 127.0.0.1 -p 4000 +``` + +## License + +MIT \ No newline at end of file diff --git a/src/cli.rs b/src/cli.rs index 4c30be1..87ee7bf 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -186,7 +186,7 @@ impl GroupCommand { } #[derive(Debug, StructOpt)] -#[structopt(name = "lares", about = "Minified RSS service")] +#[structopt(name = "lares", about = "Minimal RSS service")] pub enum Options { /// Manages feeds Feed(FeedCommand), diff --git a/src/lib.rs b/src/lib.rs index 193cc1d..3e740b7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,3 @@ -#![feature(iterator_fold_self)] - use structopt::StructOpt; #[macro_use]