search

techno-tim / littlelink-server

A lightweight, open source, stateless, and self-hosted alternative to linktree in a Docker container!
https://links.technotim.live
MIT License
921 stars 162 forks source link

Updated ReadMe - Thoughts? #147

Closed Ki-er closed 2 years ago

Ki-er commented 2 years ago

https://github.com/forks-by-kieran/littlelink-server/blob/master/README.md

I cleaned up the readme, thought Id get some thoughts before opening a PR.

timothystewart6 commented 2 years ago

Thank you! I like the direction you are going for! The only feedback is that I would still like to include some of the documentation for some of the variables that aren't BUTTONS (metrics, logs, etc). Otherwise people will ask how to implement it.

Ki-er commented 2 years ago

@timothystewart6 Added them under a configuration heading, feel free to give some feedback!

timothystewart6 commented 2 years ago

Looking good! I also liked the emojis in the headers :) I know it might not be popular but that's how I usually style most of my README.mds

Ki-er commented 2 years ago

Would you like the other emojis added such as the whale and graph for the smaller headers or just leave the current emojis in the larger ones?

I'll open a pr once I make sure all links are good and there aren't any typos!

timothystewart6 commented 2 years ago

Thanks! h1 and h2 but not h3 Sorry to be so picky!

Ki-er commented 2 years ago

H1 and H2 headings have the emojis, will open a pr!

Choubakawa commented 2 years ago

Looks great! 👍

But are we authorized to use the logo of Littlelink? Should we make a new one (based on the original) to differentiate the 2 projects?

On the same idea, I've started to list all the variables in a wiki, it's not finished yet but I don't know if it's useful as it's only more read-friendly. I share the link here: https://github.com/Choubakawa/littlelink-server/wiki/Available-variables

timothystewart6 commented 2 years ago

Thanks and the wiki looks awesome! Also, I am fine with removing the LittleLink logo but still linking and giving them credit!