JuanCanham/simpler-dash
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Adjusted ReadMe

Browse Source
This commit is contained in:
Unknown 2017-02-20 15:01:11 +01:00
parent 7675aad855
commit 040c7123bf
1 changed files with 4 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,10 +1,7 @@
# Homepage
# simple-homepage
This project is a simple, standalone, self-hosted PHP page that is meant to be your window to your server and the web.
It is your minimalist corner of the internet. The background will update with a gorgeous (and royalty free) image from [Unsplash](https://unsplash.com/), or a custom source every 20 seconds. With it, a simple menu is available to you with your most frequented links.
All the assets needed are part of the repo so it can run offline (though it won't fetch pretty background images for you).
An even simpler Homepage.
Based on: https://github.com/thetomester13/homepage
This project uses:
- jQuery
@ -13,24 +10,15 @@ This project uses:
- Font Awesome
- Unsplash
## Screenshots
Homepage w/o Menu:
![Homepage w/o Menu](example_img/homepage-wo-menu.png?raw=true)
Homepage with Menu Toggled:
![Homepage with Menu](example_img/homepage-w-menu.png?raw=true)
## To Use
Copy the config.sample.json file and rename to config.json. Be sure to update the fields as you see appropriate. You have the option to use the Unsplash API to fetch background images, or use a custom URL and JSON selector. If you choose to use Unsplash, will need to create a developer profile at [Unsplash](https://unsplash.com/) to use the background image functionality properly.
## Configure Homepage
- 'unlock_pattern' => Choose unlock pattern from [Mousetrap](https://craig.is/killing/mice)
- 'clock_format' => Choose pattern format from [PHP's date function](http://php.net/manual/en/function.date.php)
- 'items' => The menu will be in a grid of 3 icons per row on desktop. Insert any link you'd like, or {{cur}} for the current URL of the page. Choose icons from [Font Awesome](http://fontawesome.io/icons/)
### Unsplash Background Images
- 'unsplash_client_id' => Get Unsplash client ID from [Unsplash](https://unsplash.com/developers)
- 'credits' => Whether you want to give credits to the artists, or not.
### Custom Background Images
- 'custom_url' => Input a custom URL that will return proper JSON