Skip to content

Update Readme #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ExtremeFiretop merged 2 commits into from
Nov 11, 2025
Merged

Update Readme #30

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b6bd83
Reformat prerequisites section in README.md
ExtremeFiretop Nov 11, 2025
a5554f9
Clarify prerequisites for Entware and jffs scripts
ExtremeFiretop Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ Using your preferred SSH client/terminal, copy and paste the following command,
/usr/sbin/curl -fsL --retry 3 "https://raw.githubusercontent.com/AMTM-OSR/YazFi/master/YazFi.sh" -o /jffs/scripts/YazFi && chmod 0755 /jffs/scripts/YazFi && /jffs/scripts/YazFi install
```

## Prerequisites
Asuswrt-Merlin running on a supported ASUS router
Entware installed, preferably using amtm
jffs scripts enabled in the firmware; installing Entware should have taken care of this part

Please then follow instructions shown on-screen. An explanation of the settings is provided in the [FAQs](#explanation-of-yazfi-settings)

## Prerequisites
- Asuswrt-Merlin running on a supported ASUS router
- Entware (optional but recommended), preferably installed via amtm, to enable enhanced features and functionality
- jffs scripts enabled in the firmware; this can be set manually, and installing Entware via amtm usually takes care of it

## Usage
### WebUI
YazFi can be configured via the WebUI, in the Guest Network section.
Expand Down