on master help sign in
Merge pull request #322 from dym-sh/master

re-worded site-entry spec

commit5d3380874c1565f81cf0d5827af720648181f7fb authorЛu Лinveгa <aliceffekt@gmail.com> dateSat 21 Sep 2019, 14:13 (7 years ago) parente817527cffdf2b
1 file changed+19−12
README.md+19−12
README.md+19−12
@@ -15,18 +15,25 @@ This [webring](https://wiki.xxiivv.com/webring) is an attempt to inspire artists
1515Alternatively, if you your website has a dark background, use `icon.white.svg`. If your website is complaining about *https*, go ahead and host the icon yourself.
1616
1717Only the `url`, `contact`, and `langs` keys are required to join the webring. Below you can find a list of all the available keys for the various areas of the webring.
18−```javascript
19− {
20− author: <string used in the Hallway REQUIRED FOR HALLWAY>,
21− contact: <string used to contact if necessary REQUIRED FOR ALL>,
22− feed: <string url used Hallway REQUIRED FOR HALLWAY>,
23− langs: <array of iso language codes represented languages in your site ex. ['en'] REQUIRED FOR ALL>,
24− rss: <string url for rss feed>,
25− title: <string (must be alphanumeric) used for the Portal>,
26− type: <string used for the Portal>,
27− url: <string url used for Portal REQUIRED FOR ALL>,
28− wiki: <string url used for the Wiki REQUIRED FOR WIKI>
29− }
18+``` js
19+{
20+ /* REQUIRED */
21+ url: <string url used for Portal>,
22+ contact: <string used to contact if necessary>,
23+ langs: <array of represented languages (iso codes) ex. ['en', 'fr']>,
24+
25+ /* also possible */
26+ title: <string displayed alphanumeric name, used for the Portal>,
27+ type: <string used for the Portal, ex. 'blog'>,
28+ rss: <string url for rss or atom feed>,
29+
30+ /* for WIKI */
31+ author: <string used in WIKI and HALLWAY>,
32+ wiki: <string url for the .ndtl file>,
33+
34+ /* for HALLWAY */
35+ feed: <string url for the .twtxt file>
36+}
3037```
3138
3239### Webring criteria