Skip to content

Commit

Permalink
project stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
fanzeyi committed Aug 15, 2020
1 parent 15e455d commit 3bd5be3
Show file tree
Hide file tree
Showing 5 changed files with 83 additions and 5 deletions.
12 changes: 10 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
[package]
name = "lares"
version = "0.1.0"
authors = ["Zeyi Fan <[email protected]>"]
authors = ["Zeyi Fan <[email protected]>"]
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"] }
Expand All @@ -23,3 +30,4 @@ rss = "1.9.0"
prettytable-rs = "0.8.0"
futures = "0.3.5"
chrono = { version = "0.4.13" }

21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <SUBCOMMAND>
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
2 changes: 1 addition & 1 deletion src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
2 changes: 0 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#![feature(iterator_fold_self)]

use structopt::StructOpt;

#[macro_use]
Expand Down

0 comments on commit 3bd5be3

Please sign in to comment.