Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mwlistscom authored Jul 30, 2024
1 parent 3eef186 commit 96aa11d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# HomeSplash
Landing page with statistics about your server.

![image](https://github.com/user-attachments/assets/86e17e75-4b22-442a-b86b-ba4b3d6b771e)

## Features
* Edit links with icons from web page
* Edit config on web page
* Custom CSS

## Requirements
Linux, macOS, or Windows web server, and PHP 8+
This was only tested on Linux, please create Issue for any changes

## Installation
Copy all the files to the root of your webserver. The script will create a config.php, a links.json, and an icons directory
Visit your server and customize using the links on the bottom right (Links && Config)


0 comments on commit 96aa11d

Please sign in to comment.