on master help sign in
Merge remote-tracking branch 'upstream/master'
f0dd9bcckipp01
README.md+11−1
@@ -26,9 +26,18 @@ Instead of linking to the directory, you can also link to the next link in the r
26
26
27[The Hallway](https://webring.xxiivv.com/hallway.html) is a decentralized forum using [twtxt](https://twtxt.readthedocs.io/en/stable/user/twtxtfile.html) feeds.
27[The Hallway](https://webring.xxiivv.com/hallway.html) is a decentralized forum using [twtxt](https://twtxt.readthedocs.io/en/stable/user/twtxtfile.html) feeds.
28
28
29−To join, create a twtxt text file, and add its URL to your webring entry under `feed`.
29+To join, create a `.txt` file on your site, and add its URL to [your webring entry](https://github.com/XXIIVV/Webring/blob/master/scripts/sites.js) as `feed:`. The content of the file should be a dateISO string, a tab(or 3 spaces) and a message:
30+
31+```
32+2016-02-04T13:30:00+01:00 You can really go crazy here! ┐(゚∀゚)┌
33+2016-02-03T23:05:00+01:00 @<example http://example.org/twtxt.txt> welcome to twtxt!
34+2016-02-01T11:00:00+01:00 This is just another example.
35+2015-12-12T12:00:00+01:00 Fiat lux!
36+```
37+
30This file needs to be accessible via CORS, so if you're self-hosting, please make sure to allow the `webring.xxiivv.com` origin.
38This file needs to be accessible via CORS, so if you're self-hosting, please make sure to allow the `webring.xxiivv.com` origin.
31Here's an example of how to do so with Nginx:
39Here's an example of how to do so with Nginx:
40+
32```
41```
33location / {
42location / {
34 index index.html;
43 index index.html;
@@ -40,6 +49,7 @@ location / {
40 }
49 }
41}
50}
42```
51```
52+
43You don't need to allow all origins nor allow any other methods rather than GET, doing so can harm the security of your website, please read about [Cross-Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) if you intend to do anything more complicated.
53You don't need to allow all origins nor allow any other methods rather than GET, doing so can harm the security of your website, please read about [Cross-Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) if you intend to do anything more complicated.
44
54
45## API
55## API
scripts/sites.js+1−1
@@ -77,7 +77,7 @@ const sites = [
77 { url: 'https://dsdshcym.github.io' },
77 { url: 'https://dsdshcym.github.io' },
78 { url: 'https://wiki.chronica.xyz', title: 'chronica', type: 'wiki', author: 'ckipp', contact: 'ckipp@pm.me', feed: 'https://chronica.xyz/hallway.txt' },
78 { url: 'https://wiki.chronica.xyz', title: 'chronica', type: 'wiki', author: 'ckipp', contact: 'ckipp@pm.me', feed: 'https://chronica.xyz/hallway.txt' },
79 { url: 'https://boffosocko.com' },
79 { url: 'https://boffosocko.com' },
80− { url: 'https://hex22.org' },
80+ { url: 'https://hex22.org', title: 'hex22', author: 'kodedninja', contact: 'karamanhunor@pm.me', feed: 'https://t.seed.hex22.org/twtxt.txt' },
81 { url: 'https://patrikarvidsson.com' },
81 { url: 'https://patrikarvidsson.com' },
82 { url: 'https://sophieleetmaa.com' },
82 { url: 'https://sophieleetmaa.com' },
83 { url: 'https://xinniw.github.io' },
83 { url: 'https://xinniw.github.io' },