commit 4146a7760352ff3f7fa8d8a21dadc1cdd11bcd55
parent 3796678c07d0dd3cc799dc48154dcf0f996f0145
Author: Randy Au <randy.au@gmail.com>
Date: Fri, 20 Sep 2024 12:39:32 -0400
Update README.md
Diffstat:
| M | README.md | | | 34 | ++++++++++++++++++++++++++++++++-- |
1 file changed, 32 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1 +1,32 @@
-# datawebring
-\ No newline at end of file
+# Data blog webring
+
+Because it's the late '90s again and the small internet is cool.
+
+Code is 100% based off [Onionring](https://garlic.garden/onionring)
+
+
+Our webring id is `data-ring-dot-list`
+
+# Installation:
+
+Snippet to be placed on the web site to show the webring
+```
+<div id='data-ring-dot-list'>
+<script type="text/javascript" src="https://randyau.github.io/datawebring/onionring-variables.js"></script>
+<script type="text/javascript" src="https://randyau.github.io/datawebring/onionring-widget.js"></script>
+</div>
+```
+
+## Styling
+
+Add this to the `<head> ... </head>` section for styling
+```
+<link rel="stylesheet" href="https://randyau.github.io/datawebring/onionring.css">
+```
+
+## License
+
+Quoted straight from Onionring's site on 2024-09-20:
+
+
+_onionring.js and the files that make it up are licensed under the [cooperative non-violent license (CNPL) v7+,](https://thufie.lain.haus/NPL.html) which means, roughly, that anyone is allowed to download, change and share the files as long as you give credit, disclaim what changes you've made, and don't use them to violent, coercive or discriminatory ends._
