From 25673cbe7e6233f4f2a882f5878e274b45257922 Mon Sep 17 00:00:00 2001 From: ari melody Date: Tue, 21 May 2024 14:47:35 +0100 Subject: [PATCH] added license and improved documentation --- COPYING.md | 11 +++++++ README.md | 51 ++++++++++++++++++++++++++---- prideflag.js | 32 ++++++++++++------- pridetriangle.svg => prideflag.svg | 16 +++++++++- 4 files changed, 91 insertions(+), 19 deletions(-) create mode 100644 COPYING.md rename pridetriangle.svg => prideflag.svg (72%) diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..7ee6a5e --- /dev/null +++ b/COPYING.md @@ -0,0 +1,11 @@ +pride flag - copyright (c) 2024 ari melody + +this code is provided AS-IS, WITHOUT ANY WARRANTY, to be +freely redistributed and/or modified as you please, however +retaining this license in any redistribution. + +please use this flag to link to an LGBTQI+-supporting page +of your choosing! + +web: https://arimelody.me +source: https://git.arimelody.me/ari/prideflag diff --git a/README.md b/README.md index 4c506b8..b687b46 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # progressive pride flag! 🌈 +made with ❤ by ari melody -## made with ❤ by ari melody +--- -a lovely little pride flag made in svg, loaded with js, and optimised to be nice and lightweight! +a lovely little pride flag made in svg, loaded with js, and optimised to be +nice and lightweight! -it tucks into the top-right corner of any website you drop it on, and you're free to link it to whichever lgbt-supporting site you like :) +it tucks into the top-right corner of any website you drop it on, and you're +welcome to link it to whichever LGBTQI+-supporting site you like :) -![progressive pride flag](pridetriangle.svg) +![progressive pride flag](prideflag.svg) this flag currently represents: @@ -15,10 +18,46 @@ this flag currently represents: - trans pride! 🏳️‍⚧️ - intersex! ♂️ ♀️ -this flag is currently in use over at my own website, [arimelody.me](https://arimelody.me)! feel free to check it out if you'd like to see it in action! +this flag is currently in use over at my own website, [arimelody.me](https://arimelody.me)! +feel free to check it out if you'd like to see it in action! ## how do I use this on my own website? -simple! just slap [prideflag.js](prideflag.js) onto your website, and the js file will automagically generate your flag on page load! +simple! just slap [prideflag.js](prideflag.js) onto your website, and your flag +will be automagically generated on page load! + +alternatively, you are welcome to copy [prideflag.svg](prideflag.svg) +into your own site and set it up without javascript, like so: + +```html + + + + progressive pride flag + +``` + +both files contain a simple copyright license that links back to me (see [COPYING.md](COPYING.md)). +please retain this!! have fun spreading the gay! 🌈 diff --git a/prideflag.js b/prideflag.js index 0764c9a..03aecf9 100644 --- a/prideflag.js +++ b/prideflag.js @@ -1,10 +1,18 @@ -/** - * 🏳️‍🌈🏳️‍⚧️💖 pride flag 💖🏳️‍⚧️🏳️‍🌈 - * made with ❤️ by ari melody, 2024 - * - * web: https://arimelody.me - * source: https://git.arimelody.me/ari/prideflag - */ +// +// pride flag - copyright (c) 2024 ari melody +// +// this code is provided AS-IS, WITHOUT ANY WARRANTY, to be +// freely redistributed and/or modified as you please, however +// retaining this license in any redistribution. +// +// please use this flag to link to an LGBTQI+-supporting page +// of your choosing! +// +// web: https://arimelody.me +// source: https://git.arimelody.me/ari/prideflag +// + +const pride_url = "https://git.arimelody.me/ari/prideflag"; const pride_flag_svg = ` @@ -26,7 +34,7 @@ const pride_flag_svg = `; const pride_flag_css = - `#prideflag svg { + `#prideflag { position: fixed; top: 0; right: 0; @@ -36,20 +44,20 @@ const pride_flag_css = z-index: 8008135; pointer-events: none; } - #prideflag svg:hover { + #prideflag:hover { transform: scale(110%); } - #prideflag svg:active { + #prideflag:active { transform: scale(110%); } - #prideflag svg * { + #prideflag * { pointer-events: all; }`; function create_pride_flag() { const flag = document.createElement("a"); flag.id = "prideflag"; - flag.href = "https://git.arimelody.me/ari/prideflag"; + flag.href = pride_url; flag.target = "_blank"; flag.innerHTML = pride_flag_svg; return flag; diff --git a/pridetriangle.svg b/prideflag.svg similarity index 72% rename from pridetriangle.svg rename to prideflag.svg index fda4bb5..c1d346b 100644 --- a/pridetriangle.svg +++ b/prideflag.svg @@ -1,3 +1,17 @@ + + @@ -14,4 +28,4 @@ - \ No newline at end of file +