on master help sign in
Merge pull request #129 from ckipp01/master
c8468b5Лu Лinveгa
README.md+5−6
@@ -9,10 +9,10 @@ This [webring](https://wiki.xxiivv.com/webring) is an attempt to inspire artists
9```
9```
10
10
11- Add the webring icon to your website html.
11- Add the webring icon to your website html.
12−- Add your website url to the [sites.js](https://github.com/XXIIVV/webring/edit/master/scripts/sites.js) file.
12+- Add your website information to the [sites.js](https://github.com/XXIIVV/webring/edit/master/scripts/sites.js) file. The `url` key is required, but you can also include `title`, `type`, `author`, `contact`, and `rss`.
13- Submit a Pull Request with **the location of the webring icon** on your site.
13- Submit a Pull Request with **the location of the webring icon** on your site.
14
14
15−Alternatively, if you your website has a dark background, use `icon.white.svg`. If your website is complaning about *https*, go ahead and host the icon yourself. **Single page websites, and websites acting only as portals to other social platforms, will be rejected**.
15+Alternatively, 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. **Single page websites, and websites acting only as portals to other social platforms, will be rejected**.
16
16
17### Circular Linking
17### Circular Linking
18
18
@@ -24,11 +24,10 @@ Instead of linking to the directory, you can also link to the next link in the r
24
24
25## API
25## API
26
26
27−This repository does not contain mature API capabilities, but there are a couple ways to request a list of sites currently in the webring.
27+This repository does not contain mature API capabilities, but there are a couple ways to request a list of sites and other information currently in the webring.
28
28
29−- Request [sites.js on xxiivv](https://webring.xxiivv.com/scripts/sites.js) or [sites.js on github](https://raw.githubusercontent.com/XXIIVV/webring/master/scripts/sites.js)
29+- Request [sites.js on xxiivv](https://webring.xxiivv.com/scripts/sites.js) or [sites.js on github](https://raw.githubusercontent.com/XXIIVV/webring/master/scripts/sites.js) and parse it. An example can be seen [here](https://gist.github.com/ckipp01/2ab7ac42e2837b4359efeb76eb49bb54).
30−- Then parse it as text from `[` to `]`, split by `,` and then trim all whitespace and `"` in resulting array.
31−- If you'd like a already parsed list, [webring-checker.now.sh/sites](https://webring-checker.now.sh/sites) will return an json array of the sites in the webring. See [webring-checker.now.sh](https://webring-checker.now.sh) for more info.
30+- If you'd like a already parsed list, [webring-checker.now.sh/sites](https://webring-checker.now.sh/sites) will return an json array of the site objects in the webring. See [webring-checker.now.sh](https://webring-checker.now.sh) for more info on what else is available.
32
31
33## Need Help?
32## Need Help?
34
33
scripts/sites.js+1−1
@@ -75,7 +75,7 @@ const sites = [
75 , {url:"https://gndclouds.cc"}
75 , {url:"https://gndclouds.cc"}
76 , {url:"https://xuv.be"}
76 , {url:"https://xuv.be"}
77 , {url:"https://dsdshcym.github.io"}
77 , {url:"https://dsdshcym.github.io"}
78− , {url:"https://wiki.chronica.xyz"}
78+ , {url:"https://wiki.chronica.xyz", title:"chronica", type:"wiki", author:"Chris Kipp", contact:"ckipp@pm.me"}
79 , {url:"https://boffosocko.com"}
79 , {url:"https://boffosocko.com"}
80 , {url:"https://hex22.org"}
80 , {url:"https://hex22.org"}
81 , {url:"https://patrikarvidsson.com"}
81 , {url:"https://patrikarvidsson.com"}