f80ca37 · webring · git.iko.soy

git.iko.soy/webring

on master help sign in

Update README.md

f80ca37Лu Лinveгa7 years ago

README.md+5−20

compare with master

unifiedsplit

@@ -1,6 +1,6 @@

1# Webring

3−This [webring](https://wiki.xxiivv.com/webring) is an attempt to inspire artists & developers to create and maintain their own website and share traffic among each other. The webring's aim is to share hand-crafted websites such as **diaries, wikis & portfolios**.

3+This [webring](https://wiki.xxiivv.com/webring) is an attempt to inspire artists & developers to create and maintain their own website and share traffic among each other. The webring's aim is to share rich hand-crafted websites such as **diaries, wikis & portfolios**.

5## Join the webring

@@ -8,15 +8,15 @@ This [webring](https://wiki.xxiivv.com/webring) is an attempt to inspire artists

8<a href='https://webring.xxiivv.com/#random' target='_blank'><img src='https://webring.xxiivv.com/icon.black.svg'/></a>

9```

11−- Add the webring icon to your website html.

11+1) Add the webring icon to your website html.

12−- Add your website information to the [sites.js](https://github.com/XXIIVV/webring/edit/master/scripts/sites.js) file. The `url` and `contact` keys are required, but you can also include `title`, `type`, `author`, `rss`, and `feed`. The title must be alphanumeric.

12+2) Add your website information to the [sites.js](https://github.com/XXIIVV/webring/edit/master/scripts/sites.js) file. The `url` and `contact` keys are required, but you can also include `title`, `type`, `author`, `rss`, and `feed`. The title must be alphanumeric.

13−- Submit a Pull Request with **the location of the webring icon** on your site.

13+3) Submit a Pull Request with **the location of the webring icon** on your site. Pull requests with blank descriptions will be rejected.

15Alternatively, 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.

17### Webring criteria

19−**Single page websites, websites acting only as portals to other social platforms and websites with content involving violence, racism, sexism or speciesism, will be rejected**.

19+**Single page websites, websites acting only as portals to other social platforms, or websites with violent, racist, sexist or speciesist content will be rejected**.

21The aim of the webring is to display **hand-crafted personal** websites showcasing the creator's audio, visual or written work. Your business site is probably not the best fit for the webring, and will be rejected.

@@ -43,21 +43,6 @@ To join, create a `.txt` file on your site, add its URL to [your webring entry](

432015-12-12T12:00:00+01:00 Fiat lux!

44```

46−This file needs to be accessible via CORS, so if you're self-hosting, please make sure to allow the `webring.xxiivv.com` origin.

47−Here's an example of how to do so with Nginx:

48−

49−```

50−location / {

51− index index.html;

52− if ($request_method = 'GET') {

53− add_header 'Access-Control-Allow-Origin' 'https://webring.xxiivv.com';

54− add_header 'Access-Control-Allow-Methods' 'GET';

55− add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';

56− add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range';

57− }

58−}

59−```

60−

61You 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.

46You 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.

63### Joining the wiki

48### Joining the wiki