Skip to content

Commit

Permalink
doc: format
Browse files Browse the repository at this point in the history
  • Loading branch information
0x2E committed Aug 24, 2024
1 parent ffc666a commit b35cf9a
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Fusion
A lightweight RSS feed aggregator and reader with a modern interface.

A lightweight RSS feed aggregator and reader.

![preview](./assets/screenshot.png)

Key features include:

- Group, Bookmark, Search, Sniff feeds automatically,
- Group, Bookmark, Search, Sniff feeds automatically
- Import/Export OPML file
- Support RSS, Atom, JSON types feed
- Responsive, Light/Dark mode, PWA
- Displays post's content with a nice reading UI
- Lightweight, Self-hosted friendly
- Built with Golang and SQLite, Deploy with a single binary
- Pre-built Docker image
Expand All @@ -19,15 +19,18 @@ Key features include:

### 1. Docker

Choose Docker run CLI or Docker Compose examples below:
Choose Docker CLI or Docker Compose examples below:

#### 1.a. Docker CLI

```shell
docker run -it -d -p 8080:8080 -v $(pwd)/fusion:/data \
-e PASSWORD="rss123456" \
rook1e404/fusion
```

#### 1.b. Docker Compose

```compose
version: '3'
services:
Expand All @@ -41,7 +44,8 @@ services:
volumes:
- ./data:/data
```
_Change `./data` to where you want the files stored. Remember to specify localhost IP unless you want Docker exposing the port though your firewall. Then, in the same directory as this `compose.yml` file run `docker compose up -d` (or `docker-compose up -d` on older versions)._

Change `./data` to where you want the files stored. Remember to specify localhost IP unless you want Docker exposing the port though your firewall. Then, in the same directory as this `compose.yml` file run `docker compose up -d` (or `docker-compose up -d` on older versions).

### 2. Pre-built binary

Expand Down

0 comments on commit b35cf9a

Please sign in to comment.