updating readme

This commit is contained in:
Dominic DiTaranto 2025-12-30 16:06:05 -05:00
parent 5f17112de5
commit b65dd8f101

View file

@ -1,9 +1,9 @@
# Summary # Summary
Simple webring that does not require users to add javascript to their page Simple webring that does not require users to add JavaScript to their page. Instead, the webring host handles the JavaScript, and the users simply need to add a block of HTML code. This allows for users who like to keep a minimal website free from bulky JavaScript and calling CDNs.
# Getting started # How Users Add The Webring To Their Page
Add this code to your page and email jigong@tilde.green to joing the webring! You need to modify the referrer in three places to point to your own webpage. If you are the webring host, you will want to create a form for users to apply for webring membership (this can be done over email as well). Once the end user adds the webring HTML to their website (and updates the referrer link in ALL THREE places to point to their website URL), the webring host should add the user's referrer value to the sites var in static/redirect.js
``` ```
<div id="tilde-webring" style="margin: 0 auto; font-size: small;"> <div id="tilde-webring" style="margin: 0 auto; font-size: small;">
<table style="background-color: transparent; margin: 0 auto;"> <table style="background-color: transparent; margin: 0 auto;">
@ -27,6 +27,6 @@ Add this code to your page and email jigong@tilde.green to joing the webring! Yo
``` ```
# Implement your own webring # Hosting Your Own Webring
clone this repo and host the redirect.html and the static directory. You will also want to modify the code that users will put on their end page to suit your needs Clone this repo and host the redirect.html and the static directory on your website. Customize the code for the actual webring HTML that users will place on their website. Create your own logo, change the colors, etc.