From 5afcdec5839c8aca8b68def9395c0e9f2cfaec48 Mon Sep 17 00:00:00 2001 From: Timothy Stewart Date: Wed, 11 Aug 2021 22:29:39 -0500 Subject: [PATCH] docs(README): change --- README.md | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 58566fe..bd9b874 100644 --- a/README.md +++ b/README.md @@ -3,24 +3,7 @@ This project is based on the great work from [littlelink](https://github.com/sethcottle/littlelink) It takes the same simple approach to a link page and hosts it within a nodeJS server containerized for you to use. Now, customizing `LittleLink` with `littlelink-server` is as easy as passing in some environment variables. - -# 👇 What is LittleLink? - -![LittleLink](https://cdn.cottle.cloud/littlelink/social-circle.png) - -LittleLink is a lightweight DIY alternative to services like [Linktree](https://linktr.ee) -and [many.link](https://www.google.com). LittleLink was built using [Skeleton](http://getskeleton.com/), a dead simple, responsive boilerplate—we just stripped out some additional code you wouldn't need and added in branded styles for popular services. 😊 - -![Themes](https://cdn.cottle.cloud/littlelink/themes.png) - -LittleLink has more than 20 company button styles you can use and we'll be throwing more in soon. You'll also find a light and dark theme ready to go. Not a fan of the colors? Update `skeleton-light.css` or `skeleton-dark.css` to the HEX values of your choosing. - -![Performance](https://cdn.cottle.cloud/littlelink/performance.png) - -Using [Skeleton](http://getskeleton.com/) let us build something that loads quickly & doesn't have any of the unnecessary bloat you would get from using a large framework for a page that requires nothing more than simplicity. LittleLink scored a 99/100 in performance when tested with [Google Lighthouse](https://developers.google.com/web/tools/lighthouse). - - -# Getting Started +# 🚀 Getting Started `docker-compose.yml` @@ -77,3 +60,19 @@ services: - no-new-privileges:true ``` +# 👇 What is LittleLink? + +![LittleLink](https://cdn.cottle.cloud/littlelink/social-circle.png) + +LittleLink is a lightweight DIY alternative to services like [Linktree](https://linktr.ee) +and [many.link](https://www.google.com). LittleLink was built using [Skeleton](http://getskeleton.com/), a dead simple, responsive boilerplate—we just stripped out some additional code you wouldn't need and added in branded styles for popular services. 😊 + +![Themes](https://cdn.cottle.cloud/littlelink/themes.png) + +LittleLink has more than 20 company button styles you can use and we'll be throwing more in soon. You'll also find a light and dark theme ready to go. Not a fan of the colors? Update `skeleton-light.css` or `skeleton-dark.css` to the HEX values of your choosing. + +![Performance](https://cdn.cottle.cloud/littlelink/performance.png) + +Using [Skeleton](http://getskeleton.com/) let us build something that loads quickly & doesn't have any of the unnecessary bloat you would get from using a large framework for a page that requires nothing more than simplicity. LittleLink scored a 99/100 in performance when tested with [Google Lighthouse](https://developers.google.com/web/tools/lighthouse). + +