Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
electh committed Jan 17, 2025
1 parent 0725dd6 commit 06acabb
Show file tree
Hide file tree
Showing 16 changed files with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,12 @@ A modern RSS reader client for Miniflux built with React + Vite.
<tr>
<td>Feed Management
</td>
<td>General Settings
<td>Settings
</td>
</tr>
<tr>
<td><img src=images/feed.png width=600/></td>
<td><img src=images/general.png width=600/></td>
</tr>
<tr>
<td>Appearance
</td>
<td>Reading
</td>
</tr>
<tr>
<td><img src=images/appearance.png width=600 /></td>
<td><img src=images/reading.png width=600 /></td>
<td><img src=images/settings.png width=600/></td>
</tr>
<tr>
<td>Stone theme
Expand Down Expand Up @@ -110,6 +100,25 @@ A modern RSS reader client for Miniflux built with React + Vite.
- Nanostores
- DayJS

## 🚀 Deployment

### Docker Deployment

Run with Docker using the following command:

```bash
docker run -d --name nextflux -p 80:80 --restart unless-stopped electh/nextflux:latest
```
### Cloudflare Pages Deployment

1. Fork this repository to your GitHub account
2. Create a new project in Cloudflare Pages
3. Select your forked repository
4. Select Framework preset: `React(Vite)`
5. Set build command: `npm run build`
6. Set build output directory: `dist`
7. Deploy and access through the Cloudflare-assigned domain

## 📝 Configuration

The app requires a Miniflux server to function. You'll need to provide:
Expand Down
Binary file removed images/appearance.png
Binary file not shown.
Binary file modified images/code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/feed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/general.png
Binary file not shown.
Binary file modified images/images.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/podcast.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/reading.png
Binary file not shown.
Binary file modified images/responsive.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/stone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/youtube.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 06acabb

Please sign in to comment.