update README

This commit is contained in:
Max Böck 2019-04-14 21:36:15 +02:00
parent 651ab16903
commit 85fd1f212f

View file

@ -1,12 +1,17 @@
# Webring Starter Kit
A boilerplate to host your own community of sites, also known as a [webring]().
Inspired by this post from [Charlie Owen](https://www.sonniesedge.net/posts/webrings)
A boilerplate to host your own community of sites, also known as a [webring](https://en.wikipedia.org/wiki/Webring).
Inspired by this post from [Charlie Owen](https://www.sonniesedge.net/posts/webrings).
Uses [Eleventy](https://www.11ty.io) and [Netlify](https://www.netlify.com/) to build a central directory for member sites.
People can link to `/prev`, `/random` and `/next` and be redirected to members of the ring.
Uses [Eleventy](https://www.11ty.io) and [Netlify](https://www.netlify.com/) to build a central directory for member sites. People can link to `/prev`, `/random` and `/next` and be redirected to members of the ring.
[Example Site](https://webrings.netlify.com)
See the [Demo Site](https://webrings.netlify.com)
* Admins manage the ring on Github
* Let people add their site through pull request or submit via Netlify Form
* Publish a Code of Conduct
* Provide an embed code that renders a badge (as a web component)
* Publish an index of all member RSS feeds
## How to host a ring