Skip to content

Commit d58299a

Browse files
committed
Update readme
1 parent 869a064 commit d58299a

File tree

1 file changed

+6
-30
lines changed

1 file changed

+6
-30
lines changed

README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
# RSS Blogroll Networks
1+
# RSS Blogroll Network
22

3-
RSS feeds can programmatically define a [blogroll using OPML](https://opml.org/blogroll.opml).
4-
These blogrolls help people who read your blog discover other websites you think are worth promoting.
3+
A website that maps connections between blogs, blogrolls, web-rings, and other RSS-related entities.
4+
In particular, this website uses [OPML blogrolls](https://opml.org/blogroll.opml) as the basis for crawling blogs.
55

6-
This project maps connections between blogs and other RSS-enabled entities.
7-
The size and interconnectedness of the network can be tracked over time.
8-
9-
This project uses the [Feed2Pages-action crawler](https://github.com/ralexander-phi/feed2pages-action) to walk the blogroll network.
6+
https://alexsci.com/rss-blogroll-network/
107

118
[Read the blog post to learn more](https://alexsci.com/blog/blogroll-network/).
129

@@ -17,36 +14,15 @@ The best way to join the network is for a blog already in the network to add you
1714
This may happen organically over time if you have content that's interesting to others in the network.
1815
There are no restrictions on what sites can join the network organically, as the network is decentralized.
1916

20-
To help the network get bootstrapped, and discover disjoint parts of the network, you can open a GitHub Issue (or PR) to add you blog.
21-
Please first check to see if your site is listed to avoid maintainance overhead.
22-
Since manually added sites are semi-endorsed, the following qualification criteria is used:
23-
24-
* You have an RSS feed
25-
* You have an OPML blogroll
26-
* It promotes at least two blogs or websites
27-
* Your OPML blogroll is discoverable:
28-
* As an element of your RSS feed; or
29-
* As a link on your website
30-
* Your site is personal, non-commercial, and ad-free
31-
* Your site has human generated content
32-
* Content may be in any language
33-
* Content is reasonably "safe for work"
34-
* You aren't blocking us via `robots.txt`
35-
3617

3718
## Opt out of the network
3819

39-
We'll respect your decision if you don't want your website listed here.
40-
41-
Our crawler uses the `Feed2Pages/*` User-Agent string and respects `robots.txt`.
42-
Block this User-Agent (or all bots) from accessing your RSS feed using your `robots.txt` file.
20+
See [privacy](https://alexsci.com/rss-blogroll-network/privacy/#opt-outs-for-the-crawler) to learn more.
4321

4422

4523
## Running the crawler
4624

4725
Build https://github.com/ralexander-phi/feed2pages-action, which has the crawler code.
48-
26+
Run the crawler using `../feed2pages-action/util`.
4927
Then build this project (`go build`) and run the analysis tool: `./rss-blogroll-network`.
50-
5128
Finally build the site with hugo: `hugo` or `hugo server`.
52-

0 commit comments

Comments
 (0)