Skip to content

Commit 3bd5be3

Browse files
committed
project stuff
1 parent 15e455d commit 3bd5be3

File tree

5 files changed

+83
-5
lines changed

5 files changed

+83
-5
lines changed

Cargo.toml

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
[package]
22
name = "lares"
33
version = "0.1.0"
4-
authors = ["Zeyi Fan <[email protected]>"]
4+
authors = ["Zeyi Fan <[email protected]>"]
55
edition = "2018"
6+
description = "Simple RSS Reader Service (Fever API backend)"
7+
license = "MIT"
8+
homepage = "https://github.com/fanzeyi/lares"
9+
readme = "README.md"
10+
keywords = ["rss", "rssreader", "fever"]
11+
categories = [] # :(
612

7-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
13+
[badges]
14+
maintenance = { status = "actively-developed" }
815

916
[dependencies]
1017
rusqlite = { version = "0.23", features = ["array", "bundled", "chrono"] }
@@ -23,3 +30,4 @@ rss = "1.9.0"
2330
prettytable-rs = "0.8.0"
2431
futures = "0.3.5"
2532
chrono = { version = "0.4.13" }
33+

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Zeyi Fan
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Lares: Minimal Fever API Implementation
2+
3+
[![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)
4+
5+
**Lares** is a minimal [Fever API](https://feedafever.com/api) implementation
6+
written in Rust. It aims to provide a RSS reader backend with zero setup. It
7+
uses SQLite 3 as storage engine. **It does not provide an user interface.**
8+
9+
It is recommended to use Reeder as client to lares.
10+
11+
## Install
12+
13+
```
14+
cargo install lares
15+
```
16+
17+
_Binary package will be provided in the future._
18+
19+
## Usage
20+
21+
Lares consists of two parts, CLI and server. Feeds and groups are only
22+
manageable via the command line interface.
23+
24+
```
25+
$ lares --help
26+
lares 0.1.0
27+
Minimal RSS service
28+
29+
USAGE:
30+
lares <SUBCOMMAND>
31+
32+
FLAGS:
33+
-h, --help Prints help information
34+
-V, --version Prints version information
35+
36+
SUBCOMMANDS:
37+
feed Manages feeds
38+
group Manages group
39+
help Prints this message or the help of the given subcommand(s)
40+
server Starts web server
41+
```
42+
43+
Or, to start a server:
44+
45+
```
46+
$ lares server -H 127.0.0.1 -p 4000
47+
```
48+
49+
## License
50+
51+
MIT

src/cli.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ impl GroupCommand {
186186
}
187187

188188
#[derive(Debug, StructOpt)]
189-
#[structopt(name = "lares", about = "Minified RSS service")]
189+
#[structopt(name = "lares", about = "Minimal RSS service")]
190190
pub enum Options {
191191
/// Manages feeds
192192
Feed(FeedCommand),

src/lib.rs

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
#![feature(iterator_fold_self)]
2-
31
use structopt::StructOpt;
42

53
#[macro_use]

0 commit comments

Comments
 (0)