Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
maxboeck committed Apr 14, 2019
1 parent 651ab16 commit 85fd1f2
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 85fd1f2

Please sign in to comment.