diff --git a/README.md b/README.md index 24777c3..4e9d6ae 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,22 @@ This is a responsive admin theme for use with [YOURLS](https://github.com/YOURLS/YOURLS), a self hosted set of PHP scripts that let you run your own URL shortener. +The theme includes a slide in off page navigation, fixed below the nav url shortener on laptop and desktop and a relative postioned url shortener on mobile. + +The tables and graphs have a horizontal scroll on mobile when the viewport becomes too small. + ## Screen Shots ## Installing 1. First install the YOURLS scripts and database. -2. Download or clone this repo. -3. Put the contents of ` +2. Download or clone this repo into the plugins folder in your YOURLS install `user/plugins/`. +3. Login into the admin area of YOURLS and activate the plugin. +4. The Air 66 Admin Theme is now active. +## Customisation & Use +Feel free to use and customise this theme as you like. If you would like us to make changes to suit your needs please contact us via our [website form](https://air66design.com/contact). ## License @@ -18,6 +25,5 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md ## Acknowledgments -* Hat tip to anyone whose code was used -* Inspiration -* etc +* We took inspiration from the layout and design of [Sleeky](https://github.com/Flynntes/Sleeky) and used a number of their styles for the tables. +* [YOURLS](https://github.com/YOURLS/YOURLS)