Skip to content

Commit

Permalink
release v0.1.1 & update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
fanzeyi committed Aug 16, 2020
1 parent 55eba79 commit a821fe6
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "lares"
version = "0.1.0"
version = "0.1.1"
authors = ["Zeyi Fan <[email protected]>"]
edition = "2018"
description = "Simple RSS Reader Service (Fever API backend)"
Expand Down
51 changes: 46 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Lares: Minimal Fever API Implementation

[![Build Status](https://github.com/fanzeyi/lares/workflows/Build%20&%20Test/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)
[![Build Status](https://github.com/fanzeyi/lares/workflows/Build%20&%20Test/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)
[![Docker Status](https://img.shields.io/docker/cloud/build/fanzeyi/lares.svg)](https://hub.docker.com/r/fanzeyi/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
Expand All @@ -10,11 +12,23 @@ It is recommended to use Reeder as client to lares.

## Install

**Cargo**

```
cargo install lares
```

_Binary package will be provided in the future._
**Docker**

```
docker run -it fanzeyi/lares
```

**Pre-built Binary**

For each release, GitHub Action will attach pre-built binaries for Ubuntu,
macOS and Windows. You can find these binaries in the [release
page](https://github.com/fanzeyi/lares/releases).

## Usage

Expand All @@ -23,16 +37,19 @@ manageable via the command line interface.

```
$ lares --help
lares 0.1.0
lares 0.1.1
Minimal RSS service
USAGE:
lares <SUBCOMMAND>
lares [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-d, --database <database> [default: lares.db]
SUBCOMMANDS:
feed Manages feeds
group Manages group
Expand All @@ -43,7 +60,31 @@ SUBCOMMANDS:
Or, to start a server:

```
$ lares server -H 127.0.0.1 -p 4000
$ lares server --help
lares-server 0.1.1
Starts web server
USAGE:
lares server [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-H, --host <host> Specifies host of server [default: 127.0.0.1]
-P, --password <password> Specifies password used in authentication
-p, --port <port> Specifies port of server [default: 4000]
-u, --username <username> Specifies username used in authentication
```

To start a lares server listens to `127.0.0.1:4000` that only accepts
authentication with `lares` and `apassword` and placing the SQLite database
at `/var/lares.db`, run:

```
$ lares --database /var/lares.db server --host 127.0.0.1 --port 4000 \
--username lares --password apassword
```

## License
Expand Down

0 comments on commit a821fe6

Please sign in to comment.